Get Accounts

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
👍

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

ParameterTypeDescription
countintegerThe number of results on the current page.
Example: 50
pageintegerThe number of the current page.
Example: 2
per_pageintegerThe number of results per page.
Example: 50
totalintegerThe total number of results for all pages.
Example: 425
total_pagesintegerThe total number of pages.
Example: 9
_embeddedobject

"_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

_linksobject

"_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)

ParameterTypeDescriptionRequired
codestringn/ayes
messagestringn/ayes
descriptionstringn/ano
fieldsarray[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.

Query Params
int32
int32
string
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json