The Mini App Center offers an API that provides endpoints for retrieving and modifying data from the Organization. This article contains an overview of these endpoints.
Check the generic variables required to use the API.
Below is a summary of the available endpoints for this API:
This endpoint is used to retrieve a list of Organizations.
{
"data": [
{
"id": "GUID",
"name": "string"
},
...
]
}
If an error has occurred, it will return HTTP StatusCode 40x and the body as errors.
curl -X GET "$BASE_URL/v1/organizations" \
-H "APIKey-Auth: $API_TOKEN" \
-H "Accept: application/json"
Pay close attention to the returned ID element that is needed for other related APIs.
This endpoint allows you to retrieve details about a specific Organization identified by its unique id.
| Name |
Type |
Description |
| id |
GUID |
Organization ID (required) |
{
"data": {
"id": "GUID",
"name": "string",
"can_create_miniapps": "boolean",
"can_create_superapps": "boolean"
}
}
If an error has occurred, it will return HTTP StatusCode 40x and the body as errors.
curl -X GET "$BASE_URL/v1/organizations/{id}" \
-H "APIKey-Auth: $API_TOKEN" \
-H "Accept: application/json"
This endpoint is used to create a new Organization.
{
"name": "string",
"can_create_miniapps": "boolean",
"can_create_superapps": "boolean"
}
If the creation is successful, it will return HTTP response Status "201 Created" and no body. Otherwise, it will show HTTP StatusCode 40x and the body as errors.
curl -X POST "$BASE_URL/v1/organizations" \
-H "APIKey-Auth: $API_TOKEN" \
-H "Accept: application/json" \
-d '{
"name": "Testing"
"can_create_miniapps": true,
"can_create_superapps": false
}'
This endpoint updates details about a specific Organization identified by its unique id.
| Name |
Type |
Description |
| id |
GUID |
Organization ID (required) |
{
"name": "string",
"can_create_miniapps": "boolean",
"can_create_superapps": "boolean"
}
If the update is successful, it will return HTTP response Status "204 No Content" and no body. Otherwise, it will show HTTP StatusCode 40x and the body as errors.
curl -X PUT "$BASE_URL/v1/organizations/{id}" \
-H "APIKey-Auth: $API_TOKEN" \
-H "Accept: application/json" \
-d '{
"name": "Testing"
"can_create_miniapps": true,
"can_create_superapps": true
}'
This endpoint deletes a specific Organization identified by its unique id.
| Name |
Type |
Description |
| id |
GUID |
Organization ID (required) |
If the deletion is successful, it will return HTTP response Status "204 No Content" and no body. Otherwise, it will show HTTP StatusCode 40x and the body as errors.
curl -X DELETE "$BASE_URL/v1/organizations/{id}" \
-H "APIKey-Auth: $API_TOKEN" \
-H "Accept: application/json"
This endpoint is used to invite a member of the Organization.
| Name |
Type |
Description |
| id |
GUID |
Organization ID (required) |
{
"email": "string",
"role": "string" /* "OrgAdm":Organization Administrator, "SuperAppAdm":Super App Administrator, "MiniAppReview":Mini App Review, "MiniAppDev":Mini App Developer*
}
If the invitation is successful, it will return HTTP response Status "204 No Content" and no body. Otherwise, it will show HTTP StatusCode 40x and the body as errors.
curl -X POST "$BASE_URL/v1/organizations/{id}/member/invite" \
-H "APIKey-Auth: $API_TOKEN" \
-H "Accept: application/json" \
-d '{
"email": "member1@organization.com"
"role": "OrgAdm"
}'
This endpoint is used to resend the invitation to the member.
| Name |
Type |
Description |
| id |
GUID |
Organization ID (required) |
{
"email": "string"
}
If the invitation is successful, it will return HTTP response Status "204 No Content" and no body. Otherwise, it will show HTTP StatusCode 40x and the body as errors.
curl -X POST "$BASE_URL/v1/organizations/{id}/member/resendinvite" \
-H "APIKey-Auth: $API_TOKEN" \
-H "Accept: application/json" \
-d '{
"email": "member1@organization.com"
}'
This endpoint is used to delete the invitation to the member.
| Name |
Type |
Description |
| id |
GUID |
Organization ID (required) |
{
"email": "string"
}
If the deletion is successful, it will return HTTP response Status "204 No Content" and no body. Otherwise, it will show HTTP StatusCode 40x and the body as errors.
curl -X POST "$BASE_URL/v1/organizations/{id}/member/delete" \
-H "APIKey-Auth: $API_TOKEN" \
-H "Accept: application/json" \
-d '{
"email": "member1@organization.com"
}'
This endpoint suspends a member of the Organization.
| Name |
Type |
Description |
| id |
GUID |
Organization ID (required) |
{
"email": "string"
}
If the suspension is successful, it will return HTTP response Status "204 No Content" and no body. Otherwise, it will show HTTP StatusCode 40x and the body as errors.
curl -X PUT "$BASE_URL/v1/organizations/{id}/member/suspend" \
-H "APIKey-Auth: $API_TOKEN" \
-H "Accept: application/json" \
-d '{
"email": "member1@organization.com"
}'
This endpoint reactivates a member of the Organization.
| Name |
Type |
Description |
| id |
GUID |
Organization ID (required) |
{
"email": "string"
}
If the reactivation is successful, it will return HTTP response Status "204 No Content" and no body. Otherwise, it will show HTTP StatusCode 40x and the body as errors.
curl -X PUT "$BASE_URL/v1/organizations/{id}/reactivate" \
-H "APIKey-Auth: $API_TOKEN" \
-H "Accept: application/json" \
-d '{
"email": "member1@organization.com"
}'
This endpoint adds permission to the Super App in the Organization.
| Name |
Type |
Description |
| id |
GUID |
Organization ID (required) |
{
"superapp_id": "string"
}
If the permission is successfully added, it will return HTTP response Status "204 No Content" and no body. Otherwise, it will show HTTP StatusCode 40x and the body as errors.
curl -X POST "$BASE_URL/v1/organizations/{id}/superapp/permission" \
-H "APIKey-Auth: $API_TOKEN" \
-H "Accept: application/json" \
-d '{
"superapp_id": "com.genexus.verdantbank"
}'
Deletes permission on the Super App in the Organization.
| Name |
Type |
Description |
| id |
GUID |
Organization ID (required) |
{
"superapp_id": "string"
}
If the permission is successfully deleted, it will return HTTP response Status "204 No Content" and no body. Otherwise, it will show HTTP StatusCode 40x and the body as errors.
curl -X PUT "$BASE_URL/v1/organizations/{id}/superapp/permission/delete" \
-H "APIKey-Auth: $API_TOKEN" \
-H "Accept: application/json" \
-d '{
"superapp_id": "com.genexus.verdantbank"
}'