Users
Get all API users
Use this endpoint to retrieve all API users
get/api-users
Query parameters
pageinteger
The page to retrieve results from
per_pageinteger
The number of results to return per page
site_idstring
Filter results by the site they belong to
organisation_idstring uuid
Filter users by the organisation they belong to
sortstring
The field to order results by.
querystring
Filter users by their name or email
include_inactiveboolean
Filter users according to whether they are active or not.
Response
A list of API users
Example response
{
"links": {
"first": "http://example.com?page=1",
"next": "https://example.com?page=3",
"prev": "https://example.com?page=1",
"last": "https://example.com?page=4"
},
"meta": {
"from": 1,
"to": 2,
"total": 2,
"current_page": 1,
"last_page": 2,
"per_page": 15,
"path": "http://example.com/api"
},
"data": [
{
"name": "Internal",
"organisation_name": "Trybe Spa",
"status": "active",
"created_at": "2020-01-01T00:00:00.000Z",
"updated_at": "2020-01-01T00:00:00.000Z"
}
]
}Changes
No recorded changes to this endpoint across all 1 revision of this API.