User

A user is any person with an account on the platform. This includes patients, providers, and support staff.

The user model

Properties

  • Name
    id
    Type
    string
    Description

    Unique identifier for the user.

  • Name
    object
    Type
    string
    Description

    Either 'provider, 'support', or 'patient'.

  • Name
    first_name
    Type
    string
    Description

    User's first name.

  • Name
    last_name
    Type
    string
    Description

    User's last name.

  • Name
    preferred_name
    Type
    string
    Description

    User's preferred name.

  • Name
    credentials
    Type
    string
    Description

    User's credentials.

Response

{
    "id": "user_idjkvxZTqfJD734feQHa",
    "object": "provider",
    "first_name": "Sam",
    "last_name": "Wellins",
    "preferred_name": "Sam",
    "credentials": "MD"
}


GET/v2/users/:id

Retrieve a user

Retrieves the specified user.

Response

{
   "id": "user_idjkvxZTqfJD734feQHa",
   "object": "provider",
   "first_name": "Sam",
   "last_name": "Wellins",
   "preferred_name": "Sam",
   "credentials": "MD"
}


GET/v2/users

List all users

Returns a list of all users.

Response

{
  "object": "list",
  "data": [{
    "id": "user_idjkvxZTqfJD734feQHa",
    "object": "provider",
    "first_name": "Sam",
    "last_name": "Wellins",
    "preferred_name": "Sam",
    "credentials": "MD"
  }]
}