get https://api.talkdeskapp.com/apps//installations/
Scope
apps:read
Body Response - Schema
200 (successful installation information)
| Parameter | Type | Description |
|---|---|---|
| id | string | the installation ID |
| app_id | string | the app ID for the given installation |
| account_id | string | the account ID for which the app is installed |
| scopes | array[string] | list of scopes that the admin configuring the app has given access to |
| auto_provision_filters | array[objects] | List of filters used for auto-provisioning. "autoprovision_filters" subdivides into: "filter" (string) - the property to which the filter should be applied to (all, role, roleid, none). "match" (string) - the value used by the filter to find matches. |
| created_at | string | Installation date |
| _embedded | object | "_embedded" subdivides into: 1 - "created_by" (object), which subdivides into: 1.1 - "id" (string) - the ID user. 1.2 - "email" (string) - the user's email. 1.3 - "name" (string) - the user's name. 1.4 - "active" (boolean) - the activation state of the user. 1.5 - "gender" (string) - the user's gender. 1.6 - "extension" (integer) - the phone extension for the user. 1.7 - "external_phone_number" (string) - the external phone number for the user. 1.8 - "created_at" (string) - the date for the creation of the user. 1.9 - "_links" (object) - the defined links. "_links" subdivides into "self" (object) - the URI of the details of the user - which subdivides into "href" (string), default: http://api-docs.talkdesk.org/users/:id2 - "state" (object), which subdivides into: 2.1 - "state" (string) - the current state of the installation. Allowed values: "installing", "pending", "timeout", "completed", "failed", "rejected", "suspended", "revoked". 2.2 - "reason" (string) - a reason associated with the state change. 2.3 - "updated_at" (string) - date of latest change to the installation. 2.4 - "_links" (object) - date of latest change to the installation. "_links" subdivides into "self" (object) - the URI of the details of the user - which subdivides into "href" (string), default: http://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}/state |
| _links | object | "_links" subdivides into: 1 - "self" (object), which subdivides into: 1.1 - "href" (string) - default https://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}2 - "account" (object), which subdivides into: 2.1 - "href" (string) - default http://api-docs.talkdesk.org/account3 - "subscription" (object), which subdivides into: 3.1 - "href" (string) - default http://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}/subscription4 - "auto_provision_filters" (object), which subdivides into: 4.1 - "href" (string) - default http://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}/auto-provision-filters5 - "users" (object), which subdivides into: 5.1 - "href" (string) - default http://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}/users6 - "channels" (object), which subdivides into: 6.1 - "href" (string) - default http://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}/channels |
401 (unauthorized), 403 (forbidden), 404 (app/installation not found)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[object] | "fields" subdivides into "name" and "description" (both string and required) |
Troubleshooting
If you have questions or technical issues, please open a ticket using this form.