latestOpenAPI 3.0.02026-08-1284111344.5 KB
14666f4db0f8
Users
Retrieve a list of Users
Retrieves a paginated list of Users.
get/v2/users
Query parameters
pageSizenumber
Example:10
Number of records to return per page.
pagenumber
Example:1
The page index.
Headers
Authorizationstring required
Example:Bearer <token>
Bearer Token
Response
A paginated list of Users.
Example response
{
"pageSize": 10,
"page": 1,
"totalResults": 50,
"hasMore": true,
"data": [
{
"id": "USR-38c1ee5c4efa38a4",
"name": "John Smith",
"emailAddress": "john.doe@gmail.com",
"cellPhone": "1234567890",
"address": "1234 Elm Street, Apt 5B, Springfield, IL 62701, USA",
"role": "tech",
"fieldTech": true,
"active": true,
"notes": "This is a note",
"jobTypes": [
{
"id": "JT-8718036049ec4c4d",
"name": "Repair"
}
],
"serviceAreas": [
{
"id": "SA-71b8d7310acbf8cc",
"name": "San Francisco"
}
]
}
]
}