List appointments

Retrieve appointments with optional filtering by status, provider, and date range.

Authorization

AuthorizationRequiredBearer <token>

Use your API key (sk_live_* or sk_test_*) as the Bearer token.

In: header

Query Parameters

statusstring

Value in: "scheduled" | "confirmed" | "completed" | "cancelled" | "no_show"

providerIdstring

startDatestring

Format: "date-time"

endDatestring

Format: "date-time"

curl -X GET "https://platform.caramedical.com/api/v1/scheduling/appointments?status=scheduled&providerId=%3Cstring%3E&startDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z" \
  -H "Authorization: Bearer <token>"

List of appointments.

{
  "appointments": [
    {
      "id": "string",
      "patientId": "string",
      "providerId": "string",
      "datetime": "2019-08-24T14:15:22Z",
      "duration": 0,
      "status": "scheduled",
      "type": "string",
      "notes": "string",
      "patient": {
        "id": "pat_1706000000_abc123def",
        "externalId": "string",
        "joiningCode": "PULSE-A1B2C3D4",
        "email": "user@example.com",
        "phone": "+15551234567",
        "firstName": "string",
        "lastName": "string",
        "dateOfBirth": "2019-08-24",
        "gender": "string",
        "address": "string",
        "patientType": "prospect",
        "patientStatus": "active",
        "tags": [
          "string"
        ],
        "customFields": {},
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z"
      },
      "createdAt": "2019-08-24T14:15:22Z"
    }
  ]
}

Authorization

Query Parameters

Response

TypeScript