Find a user by their external id

GET 
/users/find_by_external_id/:external_id

Get a single user by their external id.

Request

Path Parameters

external_id stringrequired

A unique identifier for the user from another system.

Responses

200

User.

application/json

Schema

Schema

id uuidrequired

A unique identifier.

activated booleanrequired

Always true unless you explicitly deactivate the user.

external_id stringnullable

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.
property name* string
created_at date-timerequired

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

Example (from schema)

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

Loading...