APIUsers
List users
List users in the organization.
GET
/usersList users in the organization.
Query Parameters
offset?integer
Number of items to skip before returning results.
Format
int32Range
0 <= valueDefault
0limit?integer
Maximum number of items to return per page.
Format
int32Range
0 <= value <= 20Default
10search?string
Free-text search term to filter results by name.
Length
length <= 255sort_by?string
Default
"created_at"Value in
- "created_at"
- "display_name"
- "email"
sort_order?string
Default
"desc"Value in
- "asc"
- "desc"
group?array<string>
Filter to users belonging to any of these groups (by group name).
Response Body
application/json
application/json
curl -X GET "https://example.com/users"{ "items": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "display_name": "string", "email": "string", "groups": [ "string" ], "created_at": "2019-08-24T14:15:22Z" } ], "meta": { "total": 0, "offset": 0, "limit": 0 }}