Skip to main content

GET Calendar Events

Use the API to programatically retrieve available calendar events

Request#

Path

GET /v1/{accountCode}/calendars/{calendarId}/events

Parameters

NameTypeInDescriptionRequired
accountCodeStringpathThe Rokt Calendar merchant account code, or the subdomain of your Rokt Calendar dashboard URL.true
calendarIdStringpathThis is a unique identifier of a specific calendar in your Rokt Calendar account.true
pageNumberintegerqueryThe number of the data page you watch to receive, starting with 1. 
pageSizeintegerqueryNumber of results in a page of data you wish to receive. Must be greater than 0. 

Response#

200 OK

{  "result": {    "data": [      {        "id": "string",        "title": "string",        "description": "string",        "location": "string",        "reminderMinutes": null,        "timezoneBclId": "string",        "timezoneIanaId": "string",        "startDateTimeUtc": "2025-10-04T10:00:00.000Z",        "startDateTimeLocal": "2025-10-04T10:00:00.000Z",        "endDateTimeLocal": "2025-10-04T10:00:00.000Z",        "lastUpdateDateTimeUtc": "2025-10-04T10:00:00.000Z",        "calendarTags": [          {            "id": "string",            "text": "string"          }        ],        "calendarTimezones": [          {            "bclId": "string",            "ianaId": "string",            "offsetMinutes": null          }        ],        "calendarCustomFields": [          {            "name": "string",            "label": "string",            "url": "string",            "imageUrl": "string"          }        ]      }    ],    "totalResults": null,    "pageNumber": null,    "pageSize": null,    "totalPages": null  },  "errors": [    {      "type": "string",      "message": "string",      "code": "string"    }  ],  "success": true}

Error#

401 Unauthorized

404 NotFound

Was this article helpful?