01.software Docs

Read public admission availability for an occurrence

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

All HTTP operations
GET
/api/event-occurrences/admission-availability

Returns the public admission-type projection and a remaining-capacity hint for a single occurrence. Requires X-Publishable-Key and resolves only published public or unlisted parent events. Prices use the requested or default market, matching Cart and Checkout pricing for unchanged catalog data. The capacity value is a hint for display, not a reservation.

Authorization

publishableKey
headerX-Publishable-Key<token>

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

Query Parameters

occurrence*string

Occurrence id to read availability for.

market?string

Active tenant market handle or id. Omitted or blank uses the active primary, then oldest active market, or base pricing when no active market exists. Admission types whose products are not assigned to the resolved market are omitted. An unknown explicit market returns 404.

Response Body

Public admission availability for the occurrence

application/json
  1. response
occurrenceId?string
eventId?string
remainingCapacityHint?|

Remaining capacity hint, or null when the occurrence is uncapped.

admissionTypes?array<>

Public admission-type projection. Field-by-field shape is documented in docs/events/public-api-contract.md; raw priceReference, holds, and stock are never included.

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/admission-availability?occurrence=string'
Example Response
{  "occurrenceId": "string",  "eventId": "string",  "remainingCapacityHint": 0,  "admissionTypes": [    {}  ]}