Eventjet GraphQL API documentation

events

Lists events hosted by the organizers the authenticated account is connected to.

Authorization is required; a request without credentials fails with an error.

Those organizers always bound the result, and the hostIds filter can only narrow that set further. IDs of organizers the account is not connected to are ignored, so a query that names only foreign IDs resolves an empty connection, as does any query made by an account that is connected to no organizer at all. Leave hostIds out to cover all of the account's own organizers.

Only events that are already published and have not ended yet are resolved, including events that are hidden from the organizer's shop. To reach published and unpublished events across all organizers, use federatedEvents; the platformKey filter has no effect here and only applies there.

The query argument requires both first, the page size, and filter, so pass an empty filter object to apply no filter at all. Pass after with a cursor taken from EventEdge.cursor to continue after a previous page. Omitting query entirely resolves up to 10 events for all of the account's organizers. EventConnection.totalCount counts every matching event, not just the ones on the current page.

query GetEvents($hostId: String!, $after: String) {
  events(query: {first: 25, after: $after, filter: {hostIds: [$hostId]}}) {
    totalCount
    edges {
      cursor
      node {
        id
        name(locale: "en")
        earliestStart
      }
    }
  }
}
query GetEvents($hostId: String!, $after: String) {
  events(query: {first: 25, after: $after, filter: {hostIds: [$hostId]}}) {
    totalCount
    edges {
      cursor
      node {
        id
        name(locale: "en")
        earliestStart
      }
    }
  }
}

Arguments

ArgumentDescriptionType
queryEventQuery

Type

This field resolves to EventConnection!.