GET api/Appointment?accessToken={accessToken}&cursor={cursor}

Request Information

URI Parameters

Name	Description	Type	Additional information
accessToken		string	Required
cursor		string	Required

Body Parameters

None.

Response Information

Resource Description

AppointmentsResponse

Name	Description	Type	Additional information
Appointments		Collection of SquareAppointment	None.
NextCursor		string	None.

Response Formats

application/json, text/json

Sample:

{
  "Appointments": [
    {
      "appointmentId": "sample string 1",
      "version": 2,
      "status": "sample string 3",
      "createdAt": "2026-01-12T03:53:34.1890123+00:00",
      "updatedAt": "2026-01-12T03:53:34.1890123+00:00",
      "locationId": "sample string 6",
      "customerId": "sample string 7",
      "customerNote": "sample string 8",
      "sellerNote": "sample string 9",
      "startAt": "2026-01-12T03:53:34.1890123+00:00",
      "appointmentSegments": [
        {
          "duration_minutes": 1,
          "service_variation_id": "sample string 2",
          "team_member_id": "sample string 3",
          "service_variation_version": 4
        },
        {
          "duration_minutes": 1,
          "service_variation_id": "sample string 2",
          "team_member_id": "sample string 3",
          "service_variation_version": 4
        }
      ]
    },
    {
      "appointmentId": "sample string 1",
      "version": 2,
      "status": "sample string 3",
      "createdAt": "2026-01-12T03:53:34.1890123+00:00",
      "updatedAt": "2026-01-12T03:53:34.1890123+00:00",
      "locationId": "sample string 6",
      "customerId": "sample string 7",
      "customerNote": "sample string 8",
      "sellerNote": "sample string 9",
      "startAt": "2026-01-12T03:53:34.1890123+00:00",
      "appointmentSegments": [
        {
          "duration_minutes": 1,
          "service_variation_id": "sample string 2",
          "team_member_id": "sample string 3",
          "service_variation_version": 4
        },
        {
          "duration_minutes": 1,
          "service_variation_id": "sample string 2",
          "team_member_id": "sample string 3",
          "service_variation_version": 4
        }
      ]
    }
  ],
  "NextCursor": "sample string 1"
}

application/xml, text/xml

Sample:

<AppointmentController.AppointmentsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Beauty_Lab_Dashboard.Controllers">
  <Appointments>
    <AppointmentController.SquareAppointment>
      <appointmentId>sample string 1</appointmentId>
      <appointmentSegments xmlns:d4p1="http://schemas.datacontract.org/2004/07/Beauty_Lab_Dashboard.DTO">
        <d4p1:AppointmentSegmentDto>
          <d4p1:duration_minutes>1</d4p1:duration_minutes>
          <d4p1:service_variation_id>sample string 2</d4p1:service_variation_id>
          <d4p1:service_variation_version>4</d4p1:service_variation_version>
          <d4p1:team_member_id>sample string 3</d4p1:team_member_id>
        </d4p1:AppointmentSegmentDto>
        <d4p1:AppointmentSegmentDto>
          <d4p1:duration_minutes>1</d4p1:duration_minutes>
          <d4p1:service_variation_id>sample string 2</d4p1:service_variation_id>
          <d4p1:service_variation_version>4</d4p1:service_variation_version>
          <d4p1:team_member_id>sample string 3</d4p1:team_member_id>
        </d4p1:AppointmentSegmentDto>
      </appointmentSegments>
      <createdAt>2026-01-12T03:53:34.1890123+00:00</createdAt>
      <customerId>sample string 7</customerId>
      <customerNote>sample string 8</customerNote>
      <locationId>sample string 6</locationId>
      <sellerNote>sample string 9</sellerNote>
      <startAt>2026-01-12T03:53:34.1890123+00:00</startAt>
      <status>sample string 3</status>
      <updatedAt>2026-01-12T03:53:34.1890123+00:00</updatedAt>
      <version>2</version>
    </AppointmentController.SquareAppointment>
    <AppointmentController.SquareAppointment>
      <appointmentId>sample string 1</appointmentId>
      <appointmentSegments xmlns:d4p1="http://schemas.datacontract.org/2004/07/Beauty_Lab_Dashboard.DTO">
        <d4p1:AppointmentSegmentDto>
          <d4p1:duration_minutes>1</d4p1:duration_minutes>
          <d4p1:service_variation_id>sample string 2</d4p1:service_variation_id>
          <d4p1:service_variation_version>4</d4p1:service_variation_version>
          <d4p1:team_member_id>sample string 3</d4p1:team_member_id>
        </d4p1:AppointmentSegmentDto>
        <d4p1:AppointmentSegmentDto>
          <d4p1:duration_minutes>1</d4p1:duration_minutes>
          <d4p1:service_variation_id>sample string 2</d4p1:service_variation_id>
          <d4p1:service_variation_version>4</d4p1:service_variation_version>
          <d4p1:team_member_id>sample string 3</d4p1:team_member_id>
        </d4p1:AppointmentSegmentDto>
      </appointmentSegments>
      <createdAt>2026-01-12T03:53:34.1890123+00:00</createdAt>
      <customerId>sample string 7</customerId>
      <customerNote>sample string 8</customerNote>
      <locationId>sample string 6</locationId>
      <sellerNote>sample string 9</sellerNote>
      <startAt>2026-01-12T03:53:34.1890123+00:00</startAt>
      <status>sample string 3</status>
      <updatedAt>2026-01-12T03:53:34.1890123+00:00</updatedAt>
      <version>2</version>
    </AppointmentController.SquareAppointment>
  </Appointments>
  <NextCursor>sample string 1</NextCursor>
</AppointmentController.AppointmentsResponse>