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. | no |
| _links | object | The defined links. "_links" subdivides into: 1 - "self" (object) - the URI of the users list. 2 - "next" (object) - the URI of the next page of the users list. 3 - "first" (object) - the URI of the first page of the users list. 4 - "last" (object) - the URI of the last page of the users list. 5 - "show" (object) - the URI of a user details. 6 - "index" (object) - the URI of the users list with filters. | 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) |
TroubleshootingIf 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.