get https://api.talkdeskapp.com/users/
Scope
users:read
Body Response - Schema
200 (user details)
| Parameter | Type | Description | Required |
|---|---|---|---|
| id | string | the ID of the user | no |
| string | the e-mail of the user | no | |
| name | string | the name of the user | no |
| active | boolean | the activation state of the user | no |
| gender | string | the gender of the user | no |
| extension | integer | the phone extension for the user | no |
| external_phone_number | string | the external phone number for the user | no |
| created_at | string | the date for the creation of the user | no |
| _links | object | the defined links. "_links" subdivides into: 1 - "self" (object) - the URI of the details of the user. 1.1 - "href" (string) - default: http://api-docs.talkdesk.org/users/:id | no |
401 (unauthorized), 403 (forbidden access), 404 (user not found)
| 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.