Get All

GET

/:tenantId/appointments

Query parameters

Name	Type	Description
search	string	Searches by note, user name, patient name, patient mobile

Filter Parameters

Key	Type	Description
filter[user_id]	integer	Filters results based on the specified user ID.
filter[patient_id]	integer	Filters results based on the specified patient ID.
filter[appointment_type_id]	integer	Filters results based on the specified appointment type ID. See appointment types
filter[status]	integer	Filters results based on the specified status. See appointment statuses
filter[kind]	integer	Filters by appointment kind. Defaults to normal appointments.
filter[visit_type]	integer	Filters by visit type: 0 in-person, 1 online.
filter[start_date][from]	datetime	Filters results starting from this date and time. Format Y-m-d H:i:S
filter[start_date][to]	datetime	Filters results up to this date and time. Format Y-m-d H:i:S
filter[end_date][from]	datetime	Filters by ending date lower bound.
filter[end_date][to]	datetime	Filters by ending date upper bound.
filter[created_at][from]	datetime	Filters by creation date lower bound.
filter[created_at][to]	datetime	Filters by creation date upper bound.
filter[patient_group_id]	integer	Filters appointments by patient group.
filter[source]	string	Filters by source.
filter[external_id]	string	Filters by external identifier.

Response

{
  "data": [
    {
      "id": 1001,
      "start_date": "2024-09-19T06:45:00.000000Z",
      "end_date": "2024-09-19T07:15:00.000000Z",
      "note": "Sample note for appointment 1.",
      "user": {
        "id": 201,
        "name": "John Doe",
        "photo": null,
        "color": ""
      },
      "patient": {
        "id": 301,
        "is_deleted": false,
        "mobile": "+1234567890",
        "name": "Jane Doe",
        "sms_consent": 0,
        "photo": null
      },
      "appointment_type_id": 501,
      "status": 1,
      "notify": 0,
      "resource_id": null,
      "kind": 0,
      "visit_type": 0,
      "online_meeting": null,
      "source": null,
      "parent_id": null,
      "has_children_recurrences": false,
      "is_walk_in_visit": false
    },
    {
      "id": 1002,
      "start_date": "2024-09-21T09:45:00.000000Z",
      "end_date": "2024-09-21T10:00:00.000000Z",
      "note": "Sample note for appointment 2.",
      "user": {
        "id": 202,
        "name": "Alice Smith",
        "photo": null,
        "color": ""
      },
      "patient": {
        "id": 302,
        "is_deleted": false,
        "mobile": "+9876543210",
        "name": "Bob Smith",
        "sms_consent": 0,
        "photo": null
      },
      "appointment_type_id": 502,
      "status": 2,
      "notify": 0,
      "resource_id": null,
      "kind": 0,
      "visit_type": 0,
      "online_meeting": null,
      "source": null,
      "parent_id": null,
      "has_children_recurrences": false,
      "is_walk_in_visit": false
    }
  ],
  "links": {
    "first": "https://<Base URL>/api/v1/:tenantId/appointments?page=1",
    "last": "https://<Base URL>/api/v1/:tenantId/appointments?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "pagination.previous",
        "active": false
      },
      {
        "url": "https://<Base URL>/api/v1/:tenantId/appointments?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "pagination.next",
        "active": false
      }
    ],
    "path": "https://<Base URL>/api/v1/:tenantId/appointments",
    "per_page": 15,
    "to": 2,
    "total": 2
  }
}