Schema types
Browse every object, connection, and input type in the public schema. Field names, types, nullability, and descriptions are pulled live from public_api.schema.graphql at build time, so the contents of each table below cannot drift from the real schema — a renamed field or a changed type shows up on the next codegen + build. Note that the type list and section headings on this page are still hand-maintained: if the schema gains a brand-new type, you will need to add a <FieldTable> entry for it here.
The narrative walkthrough lives on the Reference → page; this page is a structured browser by type.
Upstream schema bug
The Artist type currently shows mismatched descriptions for the links and name fields — the descriptions are swapped on those two rows. This is a bug in the GraphQL type class in the Rails core repo, not in this site. The page below renders exactly what the schema sends us. Fix is filed; once it lands, re-running yarn gql-codegen will refresh the descriptions automatically.
The events query
The single root query that returns a paginated list of events.
events(after: String, before: String, filter: EventSearchArguments!, first: Int, last: Int): EventConnection
The last argument is declared in the schema but not implemented — sending it raises a runtime error. Use first with after or before instead. See the Reference for the full pagination story.
Object types
Event
A publicly available event with basic metadata and associations
| Field | Type | Description |
|---|---|---|
artists | [Artist!] | List of artists performing at the event |
buttonText | String | Custom label for the ticket purchase button |
canceled | Boolean | Indicates if canceled |
description | String | Full event description or program |
doorTime | ISO8601DateTime | Time when the venue doors open, in ISO8601 format |
endTime | ISO8601DateTime | Time when the event is expected to end, in ISO8601 format |
footerContent | String | Additional content shown in the event's footer |
id | Int! | Internal numeric ID of the event |
images | [Image!] | Images associated with the event, such as banners or thumbnails |
minimumAge | Int | Minimum age required to attend the event |
name | String! | Display name of the event |
openIn | String | Indicates how the tickets link should open (e.g. 'new_tab') |
priceMax | Float | Maximum ticket price |
priceMin | Float | Minimum ticket price |
promoter | String | Name of the promoter or organizer |
slug | String! | Unique identifier for the event, used in URLs |
soldOut | Boolean | Indicates if sold out |
startTime | ISO8601DateTime | Time when the event is scheduled to start, in ISO8601 format |
support | String | Names of any supporting acts or performers |
tags | [String!] | List of tags associated with the event |
ticketsUrl | String | URL where tickets for the event can be purchased |
updatedAt | ISO8601DateTime | Last updated timestamp |
venue | Venue | Venue where the event takes place |
Venue
A venue where events take place, including address and location details
| Field | Type | Description |
|---|---|---|
city | String | City where the venue is located |
country | String | Country where the venue is located |
currency | String | Currency code used at the venue |
id | Int! | Internal numeric ID of the venue |
latitude | String | Latitude coordinate of the venue |
locale | String | Locale code for the venue’s preferred language or formatting |
logoUrl | String | URL of the venue’s logo image |
longitude | String | Longitude coordinate of the venue |
name | String | Display name of the venue |
postalCode | String | Postal or ZIP code of the venue |
state | String | State or region where the venue is located |
street1 | String | Primary street address of the venue |
street2 | String | Secondary address line of the venue |
timezone | String | Timezone identifier for the venue |
updatedAt | ISO8601DateTime | Last updated timestamp |
Artist
An artist listed in an event announcement, including their name and optional external links.
| Field | Type | Description |
|---|---|---|
id | Int | The artist's uniqe ID |
links | [PublicArtistLink!] | The display name of the artist. |
name | String! | A list of external links related to the artist (e.g. website, social media). |
updatedAt | ISO8601DateTime | Last updated timestamp |
PublicArtistLink
A link related to the artist, such as their website or social media profile.
| Field | Type | Description |
|---|---|---|
url | String! | The URL of the artist's external profile or website. |
Image
Represents an image associated with an announcement, with optional variants
| Field | Type | Description |
|---|---|---|
highlighted | Boolean | Whether this image should be emphasized in the UI |
name | String! | Descriptive name or label for the image |
variants | [ImageVariant!] | List of named image variants for different display contexts |
ImageVariant
Named variant of an image, such as thumbnail or banner
| Field | Type | Description |
|---|---|---|
src | String! | URL of the image for this variant |
variant | String! | Name or key identifying the image variant (e.g. 'thumb', 'large') |
Connection types
These follow the Relay cursor connection spec and are returned from the events query.
EventConnection
The connection type for Event.
| Field | Type | Description |
|---|---|---|
edges | [EventEdge] | A list of edges. |
nodes | [Event] | A list of nodes. |
pageInfo | PageInfo! | Information to aid in pagination. |
EventEdge
An edge in a connection.
| Field | Type | Description |
|---|---|---|
cursor | String! | A cursor for use in pagination. |
node | Event | The item at the end of the edge. |
PageInfo
Information about pagination in a connection.
| Field | Type | Description |
|---|---|---|
endCursor | String | When paginating forwards, the cursor to continue. |
hasNextPage | Boolean! | When paginating forwards, are there more items? |
hasPreviousPage | Boolean! | When paginating backwards, are there more items? |
startCursor | String | When paginating backwards, the cursor to continue. |
Input types
EventSearchArguments
| Field | Type | Description |
|---|---|---|
accountIds | [Int!]! | Scope by account ids, [-1] for all |
endDate | String | End date for searching events |
id | Int | Search by event id |
lastUpdatedAt | ISO8601DateTime | Only show events updated after this timestamp |
search | String | Search by event name, artist name, or tags |
slug | String | Search by event slug |
startDate | String | Start date for searching events |
Where to next
- Reference → — endpoint, authentication, pagination, errors, and worked examples.
- Public API overview → — the friendly intro, useful when you're explaining the API to a stakeholder.