Eventjet GraphQL API documentation

federatedEvents

Lists events that their organizers have published to at least one external platform.

No authorization is required, and the search is not tied to any one organizer: it spans every organizer that has published events elsewhere. Use the platformKey filter to keep only events published to one specific platform, and the hostIds filter to keep only events of specific organizers — unlike events, those IDs may name any organizer, not just your own.

How the two event lists differ:

AspecteventsQuery.federatedEvents
Authorizationrequirednone
Organizers coveredonly the account's ownany
Published to a platformnot consideredrequired
Events not published yetexcludedincluded
Events hidden from the organizer's shopincludedexcluded
platformKey filterignoredapplied

Both resolve only events that have not ended yet, and both resolve an EventConnection.

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 PageInfo.endCursor of the previous page to continue paging. Omitting query entirely resolves up to 10 events.

query GetFederatedEvents($platformKey: String!, $after: String) {
  federatedEvents(query: {first: 25, after: $after, filter: {platformKey: $platformKey}}) {
    totalCount
    pageInfo {
      endCursor
      hasNextPage
    }
    edges {
      cursor
      node {
        id
        name(locale: "en")
        earliestStart
        host {
          name
        }
      }
    }
  }
}
query GetFederatedEvents($platformKey: String!, $after: String) {
  federatedEvents(query: {first: 25, after: $after, filter: {platformKey: $platformKey}}) {
    totalCount
    pageInfo {
      endCursor
      hasNextPage
    }
    edges {
      cursor
      node {
        id
        name(locale: "en")
        earliestStart
        host {
          name
        }
      }
    }
  }
}

Arguments

ArgumentDescriptionType
queryEventQuery

Type

This field resolves to EventConnection!.