get https://api.talkdeskapp.com/express/accounts//contracts
Get reseller contract information for express accounts. This includes the number of seats, the account status and the workflow, the next transition date and status.
Scope
express-accounts-contracts:read
Body Response - Schema
200 OK
| Parameter | Type | Description |
|---|---|---|
| id | string | The account ID. Required. Example: 5ea75fe7aa224700012eae40 |
| trial | boolean | True when the account is a free trial. Required. Example: true |
| account_status | string | Account status. Required. Allowed values: ACTIVE SUSPENDED CANCELED TERMINATED Example: ACTIVE |
| license_number | integer<32> | Number of licenses. Required. = 0 Example: 10 |
| transition_date | string | Next workflow transition date. Example: 2022-03-10T16:15:50Z |
| transition_status | string | Next workflow transition status. Allowed values: ACTIVE SUSPENDED CANCELED TERMINATED Example: SUSPENDED |
400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (forbidden)
| Parameter | Type | Description |
|---|---|---|
| code | string | n/a |
| message | string | n/a |
| description | string | n/a |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) |
API Availability
The Talkdesk Express API is in GA since the 5th of July, 2024.
Troubleshooting
If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.