Get Accounts

👍
Access and Registration Authentication

🚧
If you're a reseller, please check how to get entitled to this API here.

Scope

express-accounts:read

Body Response - Schema

200 OK

Parameter	Type	Description
count	integer	The number of results on the current page. Example: 50
page	integer	The number of the current page. Example: 2
per_page	integer	The number of results per page. Example: 50
total	integer	The total number of results for all pages. Example: 425
total_pages	integer	The total number of pages. Example: 9
_embedded	object	"_embedded" subdivides into: 1 - "accounts" (array[object]). Required. 1.1 - "id" (string) - the ID of the Talkdesk account. Required. Example: 5ea75fe7aa224700012eae40 1.2 - "name"(string) - the name of the Talkdesk account. Example: josephpinetrees 1.3 - "company_name" - The name of the customer in Talkdesk CRM. Example: Joseph Pinetrees Inc. 1.4 - "status" string- The status of the Talkdesk account. Allowed values: ACTIVE CHURNED IN_TRIAL INACTIVE PROSPECT TRIAL_LOST OTHER Example: ACTIVE
_links	object	"_links" subdivides into: 1 - "first" (object) 1.1 - "href" (string) - The link to the first page. "last" (object) 2.1 - "href" (string) - The link to the last page. "next" (object) 3.1 - "href" (string) - The link to the next page. "prev" (object) 4.1 - "href" (string) - The link to the previous page. 5 - "self" (object) 5.1 - "href" (string) - The link to the current page.

400 (bad request), 401 (unauthorized), 403 (forbidden)

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" (string) "description" (string)	yes (name and description)

❗️
API Availability
The Billing Insights API becomes available on January 31st, 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.