Get users

GET 
https://us.api.nabla.com/v1/core/server/users

Retrieve a list of your organization's Core 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 objectnullable

You can use this parameter to attach key-value data to the object. You can specify up to 50 keys, with key names up to 40 characters long, all values must be of type string and up to 500 characters long.

You should not use this to store Protected Health Information (PHI) or any patient-related data.

property name*string

created_atdate-timerequired

The creation date of this object, in ISO 8601 format.

Example: 2022-03-10T19:16:23.456Z

]

has_morebooleanrequired

Example: true

next_cursornext_cursor (string)nullable

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

Example (auto)

{
  "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"
}

Authorization: http

name: bearertype: httpscheme: bearer

• curl
• python
• go
• nodejs

• CURL

curl -L 'https://us.api.nabla.com/v1/core/server/users' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>'

Request Collapse all

Base URL

https://us.api.nabla.com/v1/core/server

Auth

Bearer Token

Parameters

cursor — query

limit — query

order — query

---ASCDESC

activated — query

---truefalse

ResponseClear

Click the Send API Request button above and see the response here!