latestOpenAPI 3.0.02026-08-216686147.9 KB
6f6009a58cdd
users
companies
List Users that belong to the specified Company
get/v1/companies/{uuid}/users
Path parameters
uuidstring uuid required
The UUID of the Company to retrieve Users for
Query parameters
emailstring
Filter Users by email address (case-insensitive, partial match)
pagenumber nullable
per_pagenumber nullable
sort_order'asc' | 'desc'
Sort order for paginated results. Use desc to reverse the default ascending order.
Response
Users for the specified Company
Example response
{
"data": [
{
"uuid": "4d50d252-be0c-4d69-b77a-5bbdfef83f54",
"first_name": "Kurt",
"last_name": "Vonnegut",
"email": "kurt.vonnegut@weyland-yutani.com",
"company_uuid": "0a5cc6c6-2855-48f1-892e-7547fe9f8fc4",
"_links": {
"fieldguide": {
"href": "https://example.com/resource/or/path",
"title": "A description for the link",
"type": "text/html"
}
},
"status": "Active",
"invite_last_resent_at": "2023-01-01T12:30:00.000Z"
}
],
"_links": {
"self": {
"href": "https://api.fieldguide.io/v1/example?page=2&per_page=50"
},
"first": {
"href": "https://api.fieldguide.io/v1/example?page=1&per_page=50"
},
"last": {
"href": "https://api.fieldguide.io/v1/example?page=10&per_page=50"
},
"previous": {
"href": "https://api.fieldguide.io/v1/example?page=1&per_page=50"
},
"next": {
"href": "https://api.fieldguide.io/v1/example?page=3&per_page=50"
}
}
}