List all clients

GET

clients

cURL

curl --request GET \
  --url https://api.caspen.com/v1/clients

{
  "data": [
    {
      "id": "<string>",
      "title": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "preferred_name": "<string>",
      "profession": "<string>",
      "email": "<string>",
      "date_of_birth": "<string>",
      "sex": "<string>",
      "gender_identity": "<string>",
      "pronouns": "<string>",
      "privacy_policy_consent": "<string>",
      "medications": [
        {
          "name": "<string>",
          "dosage": "<string>"
        }
      ],
      "allergies": [
        {
          "name": "<string>",
          "reaction": "<string>"
        }
      ],
      "intolerances": [
        "<string>"
      ],
      "emergency_contact_name": "<string>",
      "emergency_contact_phone": "<string>",
      "emergency_contact_relationship": "<string>",
      "notes": "<string>",
      "alert": "<string>",
      "referral_type_id": "<string>",
      "referral_description": "<string>",
      "referred_by_id": "<string>",
      "phone_number": "<string>",
      "phone_numbers": [
        {
          "id": "<string>",
          "code": "<string>",
          "number": "<string>",
          "type": "<string>"
        }
      ],
      "address": {
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "country_code": "<string>"
      },
      "tag_ids": [
        "<string>"
      ],
      "created_at": "<string>"
    }
  ],
  "links": {
    "prev": "<string>",
    "next": "<string>"
  }
}

Query Parameters

cursor

string

limit

integer

Required range: 1 <= x <= 100

Response

Paginated set of ClientResource

data

ClientResource · object[]

required

Show child attributes

data.id

string

The client's unique identifier.

data.title

string | null

The client's honorific title.

data.first_name

string

The client's given name.

data.last_name

string

The client's family name.

data.preferred_name

string | null

The client's preferred name.

data.profession

string | null

The client's profession or occupation.

data.email

string | null

The client's email address.

data.date_of_birth

string | null

The client's date of birth (ISO 8601).

data.sex

string | null

The client's sex assigned at birth.

data.gender_identity

string | null

The client's gender identity.

data.pronouns

string | null

The client's pronouns.

The client's privacy policy consent status.

data.medications

object[] | null

The client's medications.

Show child attributes

data.medications.name

string

data.medications.dosage

string | null

data.allergies

object[] | null

The client's allergies.

Show child attributes

data.allergies.name

string

data.allergies.reaction

string | null

data.intolerances

string[] | null

The client's intolerances.

data.emergency_contact_name

string | null

The client's emergency contact name.

data.emergency_contact_phone

string | null

The client's emergency contact phone number.

data.emergency_contact_relationship

string | null

The client's relationship to the emergency contact.

data.notes

string | null

The client's practitioner or admin notes.

data.alert

string | null

The client's alert message for staff.

data.referral_type_id

string | null

The client's referral type identifier.

data.referral_description

string | null

The client's referral description.

data.referred_by_id

string | null

The client's referring entity identifier.

data.phone_number

string | null

The client's primary phone number.

data.phone_numbers

object[]

A list of the client's additional phone numbers.

Show child attributes

data.phone_numbers.id

string

data.phone_numbers.code

string

data.phone_numbers.number

string

data.phone_numbers.type

string | null

data.address

object

The client's address details.

Show child attributes

data.address.line1

string | null

data.address.line2

string | null

data.address.city

string | null

data.address.state

string | null

data.address.postal_code

string | null

data.address.country_code

string | null

data.tag_ids

string[]

The IDs of tags attached to the client.

data.created_at

string

The timestamp when the client was created (ISO 8601).

links

object

required

Show child attributes

links.prev

string | null

required

links.next

string | null

required

Create a client

⌘I

cURL

curl --request GET \
  --url https://api.caspen.com/v1/clients

{
  "data": [
    {
      "id": "<string>",
      "title": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "preferred_name": "<string>",
      "profession": "<string>",
      "email": "<string>",
      "date_of_birth": "<string>",
      "sex": "<string>",
      "gender_identity": "<string>",
      "pronouns": "<string>",
      "privacy_policy_consent": "<string>",
      "medications": [
        {
          "name": "<string>",
          "dosage": "<string>"
        }
      ],
      "allergies": [
        {
          "name": "<string>",
          "reaction": "<string>"
        }
      ],
      "intolerances": [
        "<string>"
      ],
      "emergency_contact_name": "<string>",
      "emergency_contact_phone": "<string>",
      "emergency_contact_relationship": "<string>",
      "notes": "<string>",
      "alert": "<string>",
      "referral_type_id": "<string>",
      "referral_description": "<string>",
      "referred_by_id": "<string>",
      "phone_number": "<string>",
      "phone_numbers": [
        {
          "id": "<string>",
          "code": "<string>",
          "number": "<string>",
          "type": "<string>"
        }
      ],
      "address": {
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "country_code": "<string>"
      },
      "tag_ids": [
        "<string>"
      ],
      "created_at": "<string>"
    }
  ],
  "links": {
    "prev": "<string>",
    "next": "<string>"
  }
}

API documentation

Appointments

Availabilities

Availability Slots

Clients

Contacts

Locations

Practitioners

Services

Query Parameters

Response