Skip to content

Get user

Request

Get details of the user given by the ID.

Security
api_key
Path
userIdstringrequired

The ID of the user to be returned.

curl -i -X GET \
  'https://coreapi.hoxton.ai/_mock/v1/users/{userId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK.

Bodyapplication/json
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": [
    "member"
  ],
  "siteIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]
}