Get calendar events

Retrieves calendar events visible to the caller, ordered by start time, with optional filtering (calendarId, connectedAccountId, startsAt date range), sorting, and pagination. Event ids match the entityId of the messaging.calendar.event.changed webhook event.

POST
/v1/messaging/calendar-events/search

Authorization

apiKeyAuth
x-api-key<token>

API key authentication. Create an API key in your user profile and include it in the x-api-key header.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://loading/api/v1/messaging/calendar-events/search" \  -H "Content-Type: application/json" \  -d '{}'
{
  "customColumns": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "label": "string",
      "entityType": "contact",
      "type": "plain"
    }
  ],
  "filters": [
    {
      "field": "string",
      "operator": "equals",
      "value": "string"
    }
  ],
  "searchTerm": "string",
  "sortDescriptor": {
    "field": "string",
    "direction": "asc"
  },
  "pagination": {
    "page": 1,
    "pageSize": 5,
    "totalPages": 0,
    "total": 0
  },
  "filterableFields": [
    {
      "field": "string",
      "operators": [
        "equals"
      ],
      "label": "string"
    }
  ],
  "items": [
    {
      "title": "string",
      "description": "string",
      "location": "string",
      "conferenceUrl": "string",
      "startsAt": "string",
      "endsAt": "string",
      "allDay": true,
      "timezone": "string",
      "recurrenceRule": "string",
      "status": "confirmed",
      "attendees": [
        {
          "email": "string",
          "displayName": "string",
          "responseStatus": "string",
          "isOrganizer": false
        }
      ],
      "organizer": {
        "email": "string",
        "displayName": "string",
        "responseStatus": "string",
        "isOrganizer": false
      },
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "connectedAccountId": "ac03972a-5ca5-43c5-b96f-c519ac843b7a",
      "calendarId": "9869a533-1db4-43d9-aed3-3d63324120f5",
      "provider": "google"
    }
  ]
}
"string"
"string"
"string"
"string"