get https://api.talkdeskapp.com/apps/
Scope
apps:read
Body Response - Schema
200 (the app information)
| Parameter | Type | Description |
|---|---|---|
| id | string | the ID of a specific app installation for an account |
| app_type | string | A name to identify the app type. Allowed values: "standalone", "atla" |
| name | string | a unique name identifier for the app |
| display_name | string | a friendly, human-readable name of the app |
| slug | string | a friendly identifier of the app used as a part of the app URL |
| listing_summary | string | a summary description just for the listing |
| description | string | a description of the app's main features |
| notes | string | any additional note |
| version_number | string | the current app version |
| render | string | A name to identify where the app should be rendered. Allowed values: "portal", "canvas" |
| created_type | string | the name of the company that created the app |
| sandbox | boolean | identifier of whether it is a testing environment or not |
| scopes_reason | string | the reason the app needs additional scopes |
| emails | array[object] | An array of emails that must be used for notifications regarding the app. Emails subdivides into "type" and "email", both strings. |
| assets | array[object] | "assets" subdivides into "type" (string) - allowed values: "screenshot", "video", "icon"; "description" (string) "url" (string) |
| urls | array[object] | "urls" subdivides into "type" (string) - allowed values: "redirect_uri"; "installation_subscription"; "launch_url"; "privacy_policy"; "terms_of_service"; "app_source". "url" (string) |
| subscription_types | array[object] | "subscription_types" subdivides into "type" (string) - allowed values: "trial", "paid" "license_type" (string) - allowed values: "individual", "universal" "name" (string) - the name of the subscription "price" (integer) - the monthly cost per seat "description" (string) "listing_summary" (string) "min_licenses" (integer) "max_licenses" (integer) "created_by" (string) |
| scopes | array[object] | allowed values: "openid", "refresh_token", "apps:read", "apps:write", "reports:read", "reports:write", "events:read", "account:read", "users:read", "recordings:read", "interaction-triggers:read" |
| capabilities | array[object] | List of capabilities the app will need to use. "capabilities" subdivides into "name" (string) |
| _links | object | "_links" subdivides into "self" (object), which subdivides into "href" (string) and the default is https://api-docs.talkdesk.org/apps/{app_id} |
401 (unauthorized) and 404 (app not found)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields "fields" subdivides into "name" (string/required) "description" (string/required) | array[object] | n/a | no |
Troubleshooting
If you have questions or technical issues, please open a ticket using this form.