Skip to main content
API docs by Redocly

Surreal Events API (0.1.0)

Download OpenAPI specification:Download

Steph Ridnell: Steph Ridnell<steph@surreal.live>

Create events API key

Create a new API Key for access to the Surreal Events API. To do this you need to log into a Surreal user with access to the venue(s)/group you want to access and use the app access token from the developer console to generate yourself a machine to machine API Key. Note that this URL is different to the others

Authorizations:
surrealBearerAuth

Responses

Response samples

Content type
application/json
{
  • "key": "evt_3ZbRu1bfEPFaqd29w8fK8uUu",
  • "keyId": "key_3qD8vo2yzsvpRuBWsHqtgS5Absa"
}

List performances

Return a list of performances for the requested venue(s) or venue group

Authorizations:
eventsApiKeyAuth
query Parameters
groupId
string <uuid>
Example: groupId=1cddc97d-9b5a-4a74-8a15-2dd26671c536

UUID of the group you want to fetch events for

venueIds
string <uuid>
Example: venueIds=1cddc97d-9b5a-4a74-8a15-2dd26671c536

One or more venueId UUIDs to fetch results for

startDateTime
string
Example: startDateTime=2024-07-01T00:20:00.0Z

UTC ISO Date or Datetime string that an event must start after to be included

endDateTime
string
Example: endDateTime=2024-07-28T00:20:00.0Z

UTC ISO Date or Datetime string that an event must start before to be included

Responses

Response samples

Content type
application/json
{}

List venues

Return list of venues you have access to

Authorizations:
eventsApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "venues": [
    ]
}

List group venues

Return list of venues in a venue group

Authorizations:
eventsApiKeyAuth
path Parameters
groupId
string <uuid>
Example: 1cddc97d-9b5a-4a74-8a15-2dd26671c536

UUID of the group you want to fetch events for

Responses

Response samples

Content type
application/json
{
  • "venues": [
    ]
}