Users for an Installation

📘

Supported Regions and Base URLs

Scope

apps:read

Body Response - Schema

200 (a paginated list of users of the account enabled for the app)

ParameterTypeDescription
totalintegern/a
pageintegern/a
per_pageintegern/a
_embeddedobject"_embedded" subdivides into:

1 - "users" (array[object]), which subdivides into:
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 use.
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
_linksobject"_links" subdivides into:

1.1 - "self" (object), which subdivides into:
1.1.1 - "href" (string) - default: https://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}/users

2.2 - "next" (object), which subdivides into:
2.2.1 - "href" (string) - default: https://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}/users?page=2&per_page=1
Language