Skip to content

Users

APIs to manage an Organisation's users.

Operations

List users

Request

Fetch the list of users associated with an organisation or site.

Security
api_key
Query
organisationIdstring, (uuid)

The ID of an organisation.

siteIdstring, (uuid)

The ID of a site.

includeSupportboolean

When true, include support users in the response.

Default:false
curl -i -X GET \
  'https://coreapi.hoxton.ai/_mock/v1/users?organisationId=497f6eca-6276-4993-bfeb-53cbbbba6f08&siteId=497f6eca-6276-4993-bfeb-53cbbbba6f08&includeSupport=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK.

Bodyapplication/json
Array [
emailstring, (email)required
firstNamestringrequired
idstring or null
lastNamestringrequired
namestring
organisationIdstring, (uuid)required
organisationNamestring or null
rolesArray of strings
Items Enum:"member""manager""admin""analyst""support"
siteIdsArray of strings, (uuid)

A list of IDs of the sites to user visibility.

]
Response
[
  {
    "email": "user@example.com",
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "name": "string",
    "organisationId": "c9b3f279-e3b5-4204-ad99-646257417f98",
    "organisationName": "string",
    "roles": [ … ],
    "siteIds": [ … ]
  }
]