ACacculynx
calendar

[DRAFT] Search Calendars

Changed on

[DRAFT] This endpoint retrieves calendars based on a set of search criteria. You can filter results by multiple user calendars and the jobIds associated with them. The startDate and endDate parameters are mandatory and specify the time range for the search.

post/calendars/search

Request

  • Base URL
    https://api.acculynx.com/api/v2
  • URL
    https://api.acculynx.com/api/v2/calendars/search
  • Auth
    HTTP bearer

Request body

eventTypestring[]

List of one or more event types available

calendarIdsstring[]

List of one or more user unique GUIDs associated to the calendars to search

jobIdsstring[]

List of one or more job unique GUIDs associated to the calendars to search

startDatestring date-time

The start date and time of the event in ISO 8601 UTC format.

endDatestring date-time

The end date and time of the event in ISO 8601 UTC format.

pageStartIndexinteger

The index of the first element to return

pageSizeinteger

How many items to be returned at a time.

Example request

{
  "startDate": "2025-11-05T09:00:00Z",
  "endDate": "2025-11-07T18:00:00Z",
  "pageSize": 25
}

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