The organization client object

Using the API

Developer guides

Accounts

Care plans

Catalog

Checkout links

Clients & patients

Clinics

External Rx

Insurance

Inbox

Invoices

Labs

Onboardings

Orders

Payments

PDFs

Prescriptions

Scheduler

Service pricing

Standard care

Subscriptions

File uploads

Inventory

Forms

Medical records

clinic_clients

ExternalClinicClientSchemaList · object

required

A list of all clinic clients that are associated with this organization client.

Show child attributes

primary_clinic_id

integer

required

The ID of the primary clinic that this organization client is associated with.

⌘I

{
  "clinic_clients": {
    "data": [
      {
        "can_be_called": true,
        "client_notes": "<string>",
        "clinic_id": 123,
        "created": "2023-11-07T05:31:56Z",
        "deleted": "2023-11-07T05:31:56Z",
        "external_id": "<string>",
        "has_multiple_users": true,
        "has_unread_messages_for_clinic": true,
        "id": 123,
        "is_active": true,
        "is_deleted": true,
        "is_email_unsubscribed": true,
        "is_subscribed": true,
        "last_visit_date": "2023-11-07T05:31:56Z",
        "modified": "2023-11-07T05:31:56Z",
        "organization_client_id": 123,
        "pim_id": "<string>",
        "primary_client_user_id": 123,
        "email": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "phone_number": 123,
        "primary_address": {
          "address_one": "<string>",
          "city": "<string>",
          "id": 123,
          "state": "<string>",
          "zipcode": "<string>",
          "address_two": "",
          "country": "US",
          "county": "",
          "name": "",
          "phone_number": 123
        },
        "primary_payment_method_id": 123
      }
    ],
    "next_page": "<string>",
    "has_more": false,
    "type": "list"
  },
  "primary_clinic_id": 123
}