Account Details

📘

Supported Regions and Base URLs

👍

Access and Registration

Authentication

Scope

account:read

Body Response - Schema

200 OK (account details)

ParameterTypeDescriptionRequired
idstringn/ano
namestringa unique name identifier for the account (used for its subdomain)no
company_namestringa friendly, human-readable name for the accountno
timezonestringIANA (Internet Assigned Numbers Authority) time zone databaseno
created_atstringaccount creation dateno
_linksobject"_links" subdivides into:

1 - "self" (object) - the URI of the details of the user.
1.1 - "href" (string) - default:
http://api-docs.talkdesk.org/account
1.2 - "users" (string) - default:
http://api-docs.talkdesk.org/users
no

401 (unauthorized), 403 (forbidden access), 404 (account not found)

ParameterTypeDescriptionRequired
codestringn/ayes
messagestringn/ayes
descriptionstringn/ano
fieldsarray[object]"fields" subdivides into:

"name" (string)

"description" (string)
yes (name and description)

🚧

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.

Language
Authorization
Header
Click Try It! to start a request and see the response here!