ACacculynx
calendar

Get Calendar Appointments

Changed on

Use this endpoint to get a list of appointments for the specified calendar. The request range should not exceed 90 days.

get/calendars/{calendarId}/appointments

Request

  • Base URL
    https://api.acculynx.com/api/v2
  • URL
    https://api.acculynx.com/api/v2/calendars/{calendarId}/appointments
  • Auth
    HTTP bearer

Path parameters

calendarIdstring uuid required

The calendar's unique identifier

Query parameters

eventTypestring
Example:All,Personal,InitialAppointment

Enter one or more event types, separated by commas. Only events with the specified types will be included in the response. If no value is specified, the default value will be "All". Possible values: All, Personal, InitialAppointment, MaterialDelivery, CrewLabor

pageSizeinteger

How many items to be returned at a time.

recordStartIndexinteger

The zero-based index of the first record to return.

startDatestring date required

Start date for the query, in YYYY-MM-DD format.

endDatestring date required

End date for the query, in YYYY-MM-DD format.

jobIdstring uuid

The job's unique identifier

Response

OK

countinteger

The total number of items matching the current query.

pageSizeinteger

The requested or default page size.

pageStartIndexinteger

The requested or default index of the first element to return.

Example response

{
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "Initial Appointment",
      "attendees": [
        {
          "id": "228db892-3b49-4455-b839-ffd8576d8731",
          "_link": "https://api.acculynx.com/api/v2/users/228db892-3b49-4455-b839-ffd8576d8731"
        }
      ],
      "job": {
        "id": "e591bf22-9828-4144-bca8-42cbb8c6e2c0",
        "_link": "https://api.acculynx.com/api/v2/jobs/e591bf22-9828-4144-bca8-42cbb8c6e2c0"
      },
      "start": "2023-12-07T16:03:47Z",
      "end": "2024-01-07T16:03:47Z",
      "jobName": "RC-2120: John Smith",
      "location": "123 Pleasant Grove Road, \\nACity, IL, 12345",
      "sharedWithCustomerPortal": true,
      "_link": "https://api.acculynx.com/api/v2/calendars/58ca0eab-7882-46a6-8456-854beae8fb4a/appointments/3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}

Changes