Get users

GET 
/users

Retrieve a list of your organization's Copilot API Users, ordered by creation time.

Request

Query Parameters

cursor string

The cursor you received in the next_cursor field to fetch the next page.

limit integer

Possible values: >= 1 and <= 100

The amount of objects to retrieve, between 1 and 100.

order string
Possible values: [ASC, DESC]
This flag is used to get results sorted in ascending or descending order.
Default value: ASC
activated boolean

Optional filter for activated/deactivated users.

Responses

200

A paginated list of Users.

application/json

Schema

Schema

data

object[]

required

Array [

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]

]

has_morebooleanrequired
Example: true
next_cursornext_cursor (string)nullable

An opaque cursor to fetch the next page of the collection.

Example (from schema)

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