Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26130282259.8 KB
calendar

Get Calendar Appointments

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

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

Controls how many items are returned per page in paginated responses.

  • Default: 25 items per page if not specified
  • Minimum: 1 item per page
  • Use with pageStartIndex for navigating through large result sets
recordStartIndexinteger

The index of the first element 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 available across all pages. Use this to calculate the total number of pages available.

pageSizeinteger

The number of items per page in this response. This reflects either your requested page size or the default value.

pageStartIndexinteger

The starting index of this page of results. Use with pageSize to track your position in the overall result set.

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"
    }
  ]
}