Get a user

GET 
/users/:id

Get a single user by their id.

Request

Path Parameters

id uuidrequired
The unique identifier of the Copilot API user.
Example: 23A9981B-9E46-4ADB-BB0B-8E406C624540

Responses

200

User.

application/json

Schema

Schema

iduuidrequired
A unique identifier.
Example: 98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6
activatedbooleanrequired

Always true unless you explicitly deactivate the user.

external_idstringnullable

A unique identifier for the user from another system which is given to Nabla.

Possible values: <= 256 characters

metadata

object

nullable

property name*string
created_atdate-timerequired
The creation date of this object, in ISO 8601 format.
Example: 2022-03-10T19:16:23.456Z
emailemailnullablerequireddeprecated

This is a deprecated feature, you should not have use-cases where you create Nabla email-based accounts for your API users. Please reach out if anything.

rolesrole (string)[]requireddeprecated

This is a deprecated feature, you should not have use-cases where you create users with roles other than practitioner from the API. Please reach out if anything.

Possible values: [ADMINISTRATOR, PRACTITIONER]

Example (from schema)

{
  "id": "98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6",
  "activated": true,
  "external_id": "string",
  "metadata": {},
  "created_at": "2022-03-10T19:16:23.456Z"
}