List installations¶

Method¶

GET https://papi.afi.ai/api/v1/applications/me/installations

Description¶

Installations are listed for the application defined by the authentication key. To list all available installations, use 'limit' and 'page_token' as query parameters.

Query params¶

limit int32

Max number of items in resulting page.

page_token string

Token from the previous list operation (next_page_token) to continue listing.

curl

curl -X GET \
    -H 'Authorization: {api-key}' \
    https://papi.afi.ai/api/v1/applications/me/installations

Successful response (200) schema¶

object

InstallationPage is a result of application installations listing.

next_page_token string

Next page token to continue listing operation, i.e. to be set as next request page_token. Empty on last page.

items array of objects

Array of Installation descriptions.

object

Installation describes an application installation properties. Applications can be installed into specific tenants or organization-wide. In the latter case tenant_id is empty and you may want to use "Retrieve organization info" API call to enumerate tenants inside the organization specified by the installation.

tenant_id string

The tenant where the application is installed. Empty for organization-wide application installations.

org_id string

The organization where the application is installed. Empty for tenant application installations.

Response example¶

{
  "next_page_token": "string",
  "items": [
    {
      "tenant_id": "string",
      "org_id": "string"
    }
  ]
}