Get Clients | Keet | Documentation

{
  "status": "ok",
  "clients": [
    {
      "clinic": {
        "id": 1,
        "clinic_name": "clinic_name"
      },
      "country_name": {
        "key": "value"
      },
      "documentsExpirationDate": {
        "key": "value"
      },
      "last_appointment": [
        {
          "id": 1,
          "patient_id": 1,
          "appointment_datetime": "appointment_datetime",
          "appointment_start_on": "appointment_start_on",
          "appointment_endtime": "appointment_endtime",
          "date": "date",
          "time": "time",
          "format_time": "format_time",
          "format_date": "format_date",
          "meeting_url": "meeting_url",
          "start_time": "start_time",
          "end_time": "end_time",
          "appointment_timezone_abbr": "appointment_timezone_abbr",
          "display_status": "display_status"
        },
        {
          "id": 1,
          "patient_id": 1,
          "appointment_datetime": "appointment_datetime",
          "appointment_start_on": "appointment_start_on",
          "appointment_endtime": "appointment_endtime",
          "date": "date",
          "time": "time",
          "format_time": "format_time",
          "format_date": "format_date",
          "meeting_url": "meeting_url",
          "start_time": "start_time",
          "end_time": "end_time",
          "appointment_timezone_abbr": "appointment_timezone_abbr",
          "display_status": "display_status"
        }
      ],
      "leadStar": true,
      "patient_membership_subscription": [
        {
          "key": "value"
        },
        {
          "key": "value"
        }
      ],
      "procedure": [
        {
          "key": "value"
        },
        {
          "key": "value"
        }
      ],
      "upcoming_appointment_count": 1,
      "user_image_url": "user_image_url"
    },
    {
      "clinic": {
        "id": 1,
        "clinic_name": "clinic_name"
      },
      "country_name": {
        "key": "value"
      },
      "documentsExpirationDate": {
        "key": "value"
      },
      "last_appointment": [
        {
          "id": 1,
          "patient_id": 1,
          "appointment_datetime": "appointment_datetime",
          "appointment_start_on": "appointment_start_on",
          "appointment_endtime": "appointment_endtime",
          "date": "date",
          "time": "time",
          "format_time": "format_time",
          "format_date": "format_date",
          "meeting_url": "meeting_url",
          "start_time": "start_time",
          "end_time": "end_time",
          "appointment_timezone_abbr": "appointment_timezone_abbr",
          "display_status": "display_status"
        },
        {
          "id": 1,
          "patient_id": 1,
          "appointment_datetime": "appointment_datetime",
          "appointment_start_on": "appointment_start_on",
          "appointment_endtime": "appointment_endtime",
          "date": "date",
          "time": "time",
          "format_time": "format_time",
          "format_date": "format_date",
          "meeting_url": "meeting_url",
          "start_time": "start_time",
          "end_time": "end_time",
          "appointment_timezone_abbr": "appointment_timezone_abbr",
          "display_status": "display_status"
        }
      ],
      "leadStar": true,
      "patient_membership_subscription": [
        {
          "key": "value"
        },
        {
          "key": "value"
        }
      ],
      "procedure": [
        {
          "key": "value"
        },
        {
          "key": "value"
        }
      ],
      "upcoming_appointment_count": 1,
      "user_image_url": "user_image_url"
    }
  ],
  "pagination": {
    "current_page": 1,
    "first_page_url": "first_page_url",
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "label": "label",
        "active": true,
        "url": "url"
      },
      {
        "label": "label",
        "active": true,
        "url": "url"
      }
    ],
    "path": "path",
    "per_page": {
      "key": "value"
    },
    "to": 1,
    "total": 1,
    "last_page_url": "last_page_url",
    "next_page_url": "next_page_url",
    "prev_page_url": "prev_page_url"
  }
}

Get a list of clients.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

pageintegerOptional

pageSizeintegerOptional

Response

This endpoint returns an object.

statusenum

clientslist of objects

paginationobject

Errors

400

Bad Request Error

401

Un Authorized Error

404

Not Found Error

500

Internal Server Error

500

Not Implemented Error

Authentication

Headers

Query parameters

Response

Errors