Support Organization Member

A support organization member is an organization member on the support tier. They can do supporting tasks like scheduling appointments, submitting insurance claims, and more.

The support organization member model

The support organization member model contains information about the member's email, phone number, custom fields that you have set, and more.

Properties

  • Name
    id
    Type
    string
    Description

    Unique identifier for the support organization member.

  • Name
    object
    Type
    string
    Description

    Always 'support'.

  • Name
    first_name
    Type
    string
    Description

    Member's first name.

  • Name
    middle_name
    Type
    string
    Description

    Member's middle name.

  • Name
    last_name
    Type
    string
    Description

    Member's last name.

  • Name
    email
    Type
    string
    Description

    Member's email address.

  • Name
    phone
    Type
    string
    Description

    Member's phone number.

  • Name
    medical_centers
    Type
    array of strings
    Description

    Medical centers that the member belongs to.

  • Name
    admin
    Type
    string
    Description

    Whether the member is a global admin, local admin, or not an admin.

    Possible values:
    globalAdmin
    localAdmin
    notAdmin
  • Name
    specialization
    Type
    string
    Description

    What specialization (e.g. PCP, Nurse, etc.) the member belongs to. Must be one of the specializations set for support organization members in the specializations object.

  • Name
    timezone
    Type
    string
    Description

    Member's timezone.

  • Name
    status
    Type
    string
    Description

    Current status of the member.

    Possible values:
    active
    suspended
    archived
  • Name
    change_log
    Type
    string
    Description

    Change log containing a record of all the changes to the support organization member object.

  • Name
    created_by
    Type
    string
    Description

    Creator of the support organization member.

  • Name
    created_at
    Type
    number
    Description

    Timestamp (in Unix epoch time in milliseconds) of when the member was created.

  • Name
    last_updated_at
    Type
    number
    Description

    Timestamp (in Unix epoch time in milliseconds) of when the member was last updated.

Response

{
    "id": "user_idjkvxZTqfJD734feQHa",
    "object": "support",
    "first_name": "Tom",
    "middle_name": "",
    "last_name": "Seltz",
    "email": "tom@demo.com",
    "phone": "(860)409-4300",
    "medical_centers": [
        "mctr_XbvBirnEb1Mli1OLwqnM"
    ],
    "admin": "not_admin",
    "specialization": "Biller",
    "timezone": "America/New_York",
    "status_history": [
        {
            "status": "active",
            "changed_by": "user_xeDpGyt67wTor93qKtS7",
            "changed_at": 1653798303
        }
    ],
    "custom_data": [
        {
        "key": "cfld_FZR6ioEDTkHKn62oknLF",
        "type": "string",
        "value": "Routine Care"
        }
    ],
    "change_log": "clog_lZ0kd5CsLw8rgYPlz43r",
    "created_by": "user_xeDpGyt67wTor93qKtS7",
    "created_at": 1653798303000,
    "last_updated_at": 1653798303000
}