Returns the status and activation state of an account you provisioned, including whether it is suspended. Requires the PARTNER scope.
GET/v2/api/partner/accounts/{id}
Returns the status of an account you provisioned, including whether the customer has activated it (signed in on a device). You can only read accounts your own API key created. Any other id returns 404.
status is the account's status: ACTIVE, or SUSPENDED while the account is suspended.
Authorization
Authorizationstring · headerrequired
Api-Key ak_live_…
Path parameters
idstringrequired
The account id returned on create.
Responses
200Account
dataobject
6 fields
idstring
api_keystring | null
Scoped API key for the new account, with the scopes CRM_READ, CRM_WRITE, WEBHOOKS_READ_WRITE, CONVERSATIONS_READ, PHONE_NUMBERS_READ, PHONE_NUMBERS_WRITE, AGENTS_READ, AGENTS_WRITE, SUMMARY_TEMPLATES_READ and SUMMARY_TEMPLATES_WRITE (no SMS_SEND). Returned only on create.
phone_numbersstring[]
statusstring
The account's status: ACTIVE, or SUSPENDED while the account is suspended with Suspend account.
activatedboolean
True once the customer has signed in on a device.
partner_client_refstring | null
401403The API key lacks the PARTNER scope.
errorobject
404No account with this id was provisioned by your API key (PARTNER_ACCOUNT_NOT_FOUND).