Get users
GET/users
Retrieve a list of your organization's Copilot API Users, ordered by creation time.
Requestโ
Query Parameters
The cursor you received in the next_cursor field to fetch the next page.
Possible values: >= 1
and <= 100
The amount of objects to retrieve, between 1 and 100.
Possible values: [ASC
, DESC
]
Default value: ASC
This flag is used to get results sorted in ascending or descending order.
Optional filter for activated/deactivated users.
Responsesโ
- 200
A paginated list of Users.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
data object[]required
A unique identifier.
Always true unless you explicitly deactivate the user.
Possible values: <= 256 characters
A unique identifier for the user from another system which is given to Nabla.
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.
The creation date of this object, in ISO 8601 format.
An opaque cursor to fetch the next page of the collection.
{
"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"
}