Users
List Users
Returns a paginated list of user objects.
get/v3/users
Query parameters
page[size]integer
Example:10
The maximum number of items to include per page. The last page of a collection may include fewer items.
page[number]integer
Example:1
Determines which page of the entities to retrieve.
Filter users returned in the response.
Response
A paginated list response for a collection of users.
Example response
{
"meta": {
"page": {
"number": 1,
"size": 10,
"total": 100
}
},
"data": [
{
"id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
"email": "user@email.com",
"full_name": "Test User",
"preferred_name": "test",
"active": true,
"inferred_region": "us",
"created_at": "2022-02-07T17:46:57.52Z",
"updated_at": "2022-10-08T17:00:00.52Z"
}
]
}