Request
|
Endpoint:
|
/api/users
|
|
Method:
|
GET
|
|
Headers:
|
Accept: application/vnd.cloudlx.v1+json
|
|
Authorization: Bearer <access_token>
|
Response
Example:
{
"users": [
{
"id": 915,
"customer_id": 41,
"email": "j.smith@example.com",
"first_name": "John",
"last_name": "Smith",
"phone": "+442071234567",
"time_zone": "Europe/London"
},
{
"id": 916,
"customer_id": 41,
"email": "s.jones@example.com",
"first_name": "Sam",
"last_name": "Jones",
"phone": "+442071234560",
"time_zone": "Europe/London"
},
...
]
}
|
id
|
Description
|
The id of the user
|
|
Type
|
Integer
|
|
Example
|
915
|
|
email
|
Description
|
The user's email
|
|
Type
|
String
|
|
Example
|
j.smith@example.com
|
|
first_name
|
Description
|
The user name
|
|
Type
|
String
|
|
Example
|
John
|
|
last_name
|
Description
|
The user's last name
|
|
Type
|
String
|
|
Example
|
Smith
|
|
phone
|
Description
|
The user's phone number
|
|
Type
|
String
|
|
Example
|
+442071234567
|
|
time_zone
|
Description
|
The user's default time_zone
|
|
Type
|
String (any valid timezone available in the IANA timezone database).
|
|
Example
|
Europe/London
|