01.software Docs

List public event occurrences in a date range

Use the SDK for application integration. This read-only reference covers Commerce, Customer Auth, Membership and Events.

All HTTP operations
GET
/api/event-occurrences/range

Returns the public event calendar projection for browser clients. Requires X-Publishable-Key and filters occurrences through published public or unlisted parent events. All-day rows include canonical allDayStartDate and exclusive allDayEndDateExclusive; startsAt/endsAt are local-midnight compatibility shadows. When start or end is omitted, the tenant calendar public listing defaults determine the range.

Authorization

publishableKey
headerX-Publishable-Key<token>

Tenant publishable key for authentication (sent via X-Publishable-Key header)

Query Parameters

start?string

Optional range start. Defaults to the calendar public listing start policy.

Formatdate-time
end?string

Optional range end. Defaults to the calendar public listing month window.

Formatdate-time
limit?integer

Number of occurrences to return

Range1 <= value <= 500
Default200
page?integer

Page number

Range1 <= value
Default1
calendar?string
calendarSlug?string
category?string
categorySlug?string
tag?string
tagSlug?string

Response Body

Event occurrence range projection

application/json
  1. response
docs?array<>
events?array<>
[key: string]?any

Examples may be generated from schemas; they are illustrative, not recorded successful API calls. Example snippets may omit required authentication headers.

Example Request
curl -X GET 'https://api.01.software/api/event-occurrences/range'
Example Response
{  "docs": [    {      "id": "string",      "isAllDay": true,      "allDayStartDate": "2019-08-24",      "allDayEndDateExclusive": "2019-08-24",      "event": {        "id": "string",        "isAllDay": true,        "allDayStartDate": "2019-08-24",        "allDayEndDateExclusive": "2019-08-24"      }    }  ],  "events": [    {      "id": "string",      "isAllDay": true,      "allDayStartDate": "2019-08-24",      "allDayEndDateExclusive": "2019-08-24"    }  ]}