get https://api.talkdeskapp.com/users
Scope
users:read
Body Response - Schema
200 (users list)
| Parameter | Type | Description | Required |
|---|---|---|---|
| count | integer | the number of results in the current page | no |
| total | integer | the total of results in the account | no |
| page | integer | the current page | no |
| per_page | integer | the number of results per page | no |
| total_pages | integer | the number of the total of result pages | no |
| _embedded | object | "_embedded" subdivides into: 1 - "users" (array[object]) - the results displayed in an array. 1.1 - "id" (string) - the ID of the user. 1.2 - "email" (string) - the e-mail of the user. 1.3 - "name" (string) - the name of the user. 1.4 - "active" (boolean) - the activation state of the user. 1.5 - "gender" (string) - the gender of the user. 1.6 - "extension" (integer) - the phone extension for the user. 1.7 - "external_phone_number" (string) - the external phone number for the user. 1.8 - "created_at" (string) - the date for the creation of the user. 1.9 - "_links" (object) - the defined links. 1.9.1 - "self" (object) - the URI of the details of the user. 1.9.1.1 - "href" (string) - default: http://api-docs.talkdesk.org/users/:id | no |
| _links | object | The defined links. "_links" subdivides into: 1 - "self" (object) - the URI of the users list. 1.1 - "href" (string) - the URI value. Default: http://api-docs.talkdesk.org/users 2 - "next" (object) - the URI of the next page of the users list. 2.1 - "href" (string) - the URI value. Default: http://api-docs.talkdesk.org/users?page=2 3 - "first" (object) - the URI of the first page of the users list. 3.1 - "href" (string) - the URI value. Default: http://api-docs.talkdesk.org/users?page=1 4 - "last" (object) - the URI of the last page of the users list. 4.1 - "href" (string) - the URI value. Default: http://api-docs.talkdesk.org/users?page=2 5 - "show" (object) - the URI of a user details. 5.1 - "templated" (boolean) - the URI value. Default: true 5.2 - "href" (string) - Default: http://api-docs.talkdesk.org/users/{id} 6 - "index" (object) - the URI of the users list with filters. 6.1 - "templated" (boolean) - the URI value. Default: true 6.2 - "href" (string) - Default: https://api-docs.talkdesk.org/users{?active,email,page,per_page} | no |
400 (bad request), 401 (unauthorized), 403 (forbidden access)
| 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) |
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.