Skip to content

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

FieldTypeDescription
artists[Artist!]List of artists performing at the event
buttonTextStringCustom label for the ticket purchase button
canceledBooleanIndicates if canceled
descriptionStringFull event description or program
doorTimeISO8601DateTimeTime when the venue doors open, in ISO8601 format
endTimeISO8601DateTimeTime when the event is expected to end, in ISO8601 format
footerContentStringAdditional content shown in the event's footer
idInt!Internal numeric ID of the event
images[Image!]Images associated with the event, such as banners or thumbnails
minimumAgeIntMinimum age required to attend the event
nameString!Display name of the event
openInStringIndicates how the tickets link should open (e.g. 'new_tab')
priceMaxFloatMaximum ticket price
priceMinFloatMinimum ticket price
promoterStringName of the promoter or organizer
slugString!Unique identifier for the event, used in URLs
soldOutBooleanIndicates if sold out
startTimeISO8601DateTimeTime when the event is scheduled to start, in ISO8601 format
supportStringNames of any supporting acts or performers
tags[String!]List of tags associated with the event
ticketsUrlStringURL where tickets for the event can be purchased
updatedAtISO8601DateTimeLast updated timestamp
venueVenueVenue where the event takes place

Venue

A venue where events take place, including address and location details

FieldTypeDescription
cityStringCity where the venue is located
countryStringCountry where the venue is located
currencyStringCurrency code used at the venue
idInt!Internal numeric ID of the venue
latitudeStringLatitude coordinate of the venue
localeStringLocale code for the venue’s preferred language or formatting
logoUrlStringURL of the venue’s logo image
longitudeStringLongitude coordinate of the venue
nameStringDisplay name of the venue
postalCodeStringPostal or ZIP code of the venue
stateStringState or region where the venue is located
street1StringPrimary street address of the venue
street2StringSecondary address line of the venue
timezoneStringTimezone identifier for the venue
updatedAtISO8601DateTimeLast updated timestamp

Artist

An artist listed in an event announcement, including their name and optional external links.

FieldTypeDescription
idIntThe artist's uniqe ID
links[PublicArtistLink!]The display name of the artist.
nameString!A list of external links related to the artist (e.g. website, social media).
updatedAtISO8601DateTimeLast updated timestamp

A link related to the artist, such as their website or social media profile.

FieldTypeDescription
urlString!The URL of the artist's external profile or website.

Image

Represents an image associated with an announcement, with optional variants

FieldTypeDescription
highlightedBooleanWhether this image should be emphasized in the UI
nameString!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

FieldTypeDescription
srcString!URL of the image for this variant
variantString!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.

FieldTypeDescription
edges[EventEdge]A list of edges.
nodes[Event]A list of nodes.
pageInfoPageInfo!Information to aid in pagination.

EventEdge

An edge in a connection.

FieldTypeDescription
cursorString!A cursor for use in pagination.
nodeEventThe item at the end of the edge.

PageInfo

Information about pagination in a connection.

FieldTypeDescription
endCursorStringWhen paginating forwards, the cursor to continue.
hasNextPageBoolean!When paginating forwards, are there more items?
hasPreviousPageBoolean!When paginating backwards, are there more items?
startCursorStringWhen paginating backwards, the cursor to continue.

Input types

EventSearchArguments

FieldTypeDescription
accountIds[Int!]!Scope by account ids, [-1] for all
endDateStringEnd date for searching events
idIntSearch by event id
lastUpdatedAtISO8601DateTimeOnly show events updated after this timestamp
searchStringSearch by event name, artist name, or tags
slugStringSearch by event slug
startDateStringStart 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.