Liveheats GraphQL API Reference
Liveheats uses a GraphQL API to display data on the public website (https://liveheats.com). All screens that you see when navigating through organisations and events in the Liveheats website fetch their data using the Liveheats API, so anything that you can see on the website, you can get through this API to display where and how you need.
GraphQL is a very powerful query language for APIs that allows developers to predictably extract the exact data they need by traversing the schema available. It does, however, require a bit of knowledge on how it works in order to get properly started, so if you are unfamiliar with GraphQL and it's main concepts, we suggest reading about it in https://graphql.org/learn/
The rest of this guide assumes familiarity with GraphQL Queries and their Variables and Types. It is also beneficial to get acquainted with Liveheats' data structure
Terms of Service
API Endpoints
# Staging:
https://staging.liveheats.com/api/graphql
# Production:
https://liveheats.com/api/graphql
Headers
Authorization: Bearer <YOUR_TOKEN_HERE>Queries
athlete
Description
Get an athlete by it's id
Example
Query
query athlete($id: ID!) {
athlete(id: $id) {
appearances {
...CompetitorFragment
}
createdAt
dob
entries {
...AthleteEntryFragment
}
entriesWithPendingPayments {
...EntryFragment
}
eventDivisions {
...EventDivisionFragment
}
id
image
injuries {
...InjuryFragment
}
injuryStatus
memberships {
...AthleteMembershipFragment
}
name
nationality
nfcTags {
...PhysicalTagFragment
}
properties
ranks {
...EventDivisionRankFragment
}
unfinishedEvents {
...EventFragment
}
updatedAt
users {
...UserFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"athlete": {
"appearances": [Competitor],
"createdAt": ISO8601Date,
"dob": ISO8601Date,
"entries": [AthleteEntry],
"entriesWithPendingPayments": [Entry],
"eventDivisions": [EventDivision],
"id": 4,
"image": "xyz789",
"injuries": [Injury],
"injuryStatus": "xyz789",
"memberships": [AthleteMembership],
"name": "abc123",
"nationality": "xyz789",
"nfcTags": [PhysicalTag],
"properties": {},
"ranks": [EventDivisionRank],
"unfinishedEvents": [Event],
"updatedAt": ISO8601Date,
"users": [User]
}
}
}
contest
Description
Get a contest by it's id
Example
Query
query contest($id: ID!) {
contest(id: $id) {
config {
...ContestConfigFragment
}
id
name
parent {
...ContestFragment
}
result {
... on PointsPerPlaceResult {
...PointsPerPlaceResultFragment
}
}
savedConfig {
...ContestConfigFragment
}
type
}
}
Variables
{"id": 4}
Response
{
"data": {
"contest": {
"config": ContestConfig,
"id": "4",
"name": "xyz789",
"parent": Contest,
"result": [PointsPerPlaceResult],
"savedConfig": ContestConfig,
"type": "abc123"
}
}
}
event
Description
Get an event by it's id
Example
Query
query event($id: ID!) {
event(id: $id) {
activeEntriesUsers {
...UserFragment
}
captureFields {
...PropertyFragment
}
competingTeams {
...TeamFragment
}
config {
...EventConfigFragment
}
currentHeats {
...HeatFragment
}
currentScheduleIndex
date
daysWindow
entries {
...EntryFragment
}
eventDivisions {
...EventDivisionFragment
}
fullSchedule {
...ScheduleFragment
}
hideEntries
hideFinals
hideNamesFromJudges
hideScheduledTime
id
location {
...LocationFragment
}
media {
...MediaFragment
}
name
organisation {
...OrganisationFragment
}
organisationId
paymentOptions {
...PaymentOptionsFragment
}
priorityEnabled
registrationOptions {
...RegistrationOptionsFragment
}
restrictions {
...RestrictionFragment
}
scheduledEntryClose
scheduledEntryOpen
seedFromSeriesId
sentEmails {
...EmailFragment
}
series {
...SeriesFragment
}
sponsoredContentEnabled
sponsoredContents {
...SponsoredContentFragment
}
sponsors {
...SponsorFragment
}
status
streams {
...StreamFragment
}
teamLeaderboard {
...EventTeamLeaderboardFragment
}
teams {
...TeamFragment
}
templateId
}
}
Variables
{"id": "4"}
Response
{
"data": {
"event": {
"activeEntriesUsers": [User],
"captureFields": [Property],
"competingTeams": [Team],
"config": EventConfig,
"currentHeats": [Heat],
"currentScheduleIndex": 123,
"date": ISO8601DateTime,
"daysWindow": 987,
"entries": [Entry],
"eventDivisions": [EventDivision],
"fullSchedule": Schedule,
"hideEntries": true,
"hideFinals": false,
"hideNamesFromJudges": false,
"hideScheduledTime": true,
"id": "4",
"location": Location,
"media": [Media],
"name": "abc123",
"organisation": Organisation,
"organisationId": "4",
"paymentOptions": PaymentOptions,
"priorityEnabled": true,
"registrationOptions": RegistrationOptions,
"restrictions": [Restriction],
"scheduledEntryClose": ISO8601DateTime,
"scheduledEntryOpen": ISO8601DateTime,
"seedFromSeriesId": "4",
"sentEmails": [Email],
"series": [Series],
"sponsoredContentEnabled": true,
"sponsoredContents": [SponsoredContent],
"sponsors": [Sponsor],
"status": "scheduled",
"streams": [Stream],
"teamLeaderboard": EventTeamLeaderboard,
"teams": [Team],
"templateId": 4
}
}
}
eventCompetitors
Description
Find athletes in heats for an event
Response
Returns [CompetitorResult!]!
Example
Query
query eventCompetitors(
$eventId: ID!,
$query: String!
) {
eventCompetitors(
eventId: $eventId,
query: $query
) {
... on Competitor {
...CompetitorFragment
}
... on Entry {
...EntryFragment
}
}
}
Variables
{"eventId": 4, "query": "abc123"}
Response
{"data": {"eventCompetitors": [Competitor]}}
eventDivision
Description
Get an event division by it's id
Response
Returns an EventDivision
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query eventDivision($id: ID!) {
eventDivision(id: $id) {
contestId
defaultEventDurationMinutes
division {
...DivisionFragment
}
divisionToSeasons {
...DivisionToSeasonsFragment
}
entries {
...EntryFragment
}
entryCount
entryLimit {
...EntryLimitFragment
}
event {
...EventFragment
}
eventDivision {
...EventDivisionFragment
}
eventDivisionId
eventDivisionPointAllocations {
...EventDivisionPointAllocationsFragment
}
eventDivisions {
...EventDivisionFragment
}
formatDefinition {
...FormatDefinitionFragment
}
heatConfig {
...HeatConfigFragment
}
heatDurationMinutes
heats {
...HeatFragment
}
id
leaderboards {
...LeaderboardFragment
}
leaderboardsWithPending {
...LeaderboardFragment
}
order
previewDraw {
...PreviewDrawFragment
}
properties
ranking {
...EventDivisionRankFragment
}
seededRounds {
...SeededRoundFragment
}
sponsoredContents {
...SponsoredContentFragment
}
status
teamLeaderboard {
...EventDivisionTeamLeaderboardFragment
}
template {
...TemplateFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"eventDivision": {
"contestId": 4,
"defaultEventDurationMinutes": 123,
"division": Division,
"divisionToSeasons": [DivisionToSeasons],
"entries": [Entry],
"entryCount": 123,
"entryLimit": EntryLimit,
"event": Event,
"eventDivision": EventDivision,
"eventDivisionId": "4",
"eventDivisionPointAllocations": [
EventDivisionPointAllocations
],
"eventDivisions": [EventDivision],
"formatDefinition": FormatDefinition,
"heatConfig": HeatConfig,
"heatDurationMinutes": 123,
"heats": [Heat],
"id": 4,
"leaderboards": [Leaderboard],
"leaderboardsWithPending": [Leaderboard],
"order": 987,
"previewDraw": PreviewDraw,
"properties": {},
"ranking": [EventDivisionRank],
"seededRounds": [SeededRound],
"sponsoredContents": [SponsoredContent],
"status": "registration_open",
"teamLeaderboard": EventDivisionTeamLeaderboard,
"template": Template
}
}
}
events
Description
Search for events by location or get specific events by IDs
Response
Returns [Event!]!
Example
Query
query events(
$latitude: Float,
$longitude: Float,
$radius: Float,
$ids: [ID!],
$limit: Int
) {
events(
latitude: $latitude,
longitude: $longitude,
radius: $radius,
ids: $ids,
limit: $limit
) {
activeEntriesUsers {
...UserFragment
}
captureFields {
...PropertyFragment
}
competingTeams {
...TeamFragment
}
config {
...EventConfigFragment
}
currentHeats {
...HeatFragment
}
currentScheduleIndex
date
daysWindow
entries {
...EntryFragment
}
eventDivisions {
...EventDivisionFragment
}
fullSchedule {
...ScheduleFragment
}
hideEntries
hideFinals
hideNamesFromJudges
hideScheduledTime
id
location {
...LocationFragment
}
media {
...MediaFragment
}
name
organisation {
...OrganisationFragment
}
organisationId
paymentOptions {
...PaymentOptionsFragment
}
priorityEnabled
registrationOptions {
...RegistrationOptionsFragment
}
restrictions {
...RestrictionFragment
}
scheduledEntryClose
scheduledEntryOpen
seedFromSeriesId
sentEmails {
...EmailFragment
}
series {
...SeriesFragment
}
sponsoredContentEnabled
sponsoredContents {
...SponsoredContentFragment
}
sponsors {
...SponsorFragment
}
status
streams {
...StreamFragment
}
teamLeaderboard {
...EventTeamLeaderboardFragment
}
teams {
...TeamFragment
}
templateId
}
}
Variables
{
"latitude": 123.45,
"longitude": 123.45,
"radius": 30,
"ids": ["4"],
"limit": 25
}
Response
{
"data": {
"events": [
{
"activeEntriesUsers": [User],
"captureFields": [Property],
"competingTeams": [Team],
"config": EventConfig,
"currentHeats": [Heat],
"currentScheduleIndex": 123,
"date": ISO8601DateTime,
"daysWindow": 987,
"entries": [Entry],
"eventDivisions": [EventDivision],
"fullSchedule": Schedule,
"hideEntries": true,
"hideFinals": true,
"hideNamesFromJudges": true,
"hideScheduledTime": false,
"id": "4",
"location": Location,
"media": [Media],
"name": "abc123",
"organisation": Organisation,
"organisationId": "4",
"paymentOptions": PaymentOptions,
"priorityEnabled": false,
"registrationOptions": RegistrationOptions,
"restrictions": [Restriction],
"scheduledEntryClose": ISO8601DateTime,
"scheduledEntryOpen": ISO8601DateTime,
"seedFromSeriesId": "4",
"sentEmails": [Email],
"series": [Series],
"sponsoredContentEnabled": false,
"sponsoredContents": [SponsoredContent],
"sponsors": [Sponsor],
"status": "scheduled",
"streams": [Stream],
"teamLeaderboard": EventTeamLeaderboard,
"teams": [Team],
"templateId": "4"
}
]
}
}
eventsByName
Description
get a list of events that contain the search string name
Response
Returns [Event!]
Arguments
| Name | Description |
|---|---|
search - String!
|
|
limit - Int
|
|
eventLive - Boolean
|
|
location - EventLocationInput
|
Location to search by. Provide either country or coordinates. |
radius - Float
|
Radius in kilometers to search within when providing coordinates. Default = 100.0 |
Example
Query
query eventsByName(
$search: String!,
$limit: Int,
$eventLive: Boolean,
$location: EventLocationInput,
$radius: Float
) {
eventsByName(
search: $search,
limit: $limit,
eventLive: $eventLive,
location: $location,
radius: $radius
) {
activeEntriesUsers {
...UserFragment
}
captureFields {
...PropertyFragment
}
competingTeams {
...TeamFragment
}
config {
...EventConfigFragment
}
currentHeats {
...HeatFragment
}
currentScheduleIndex
date
daysWindow
entries {
...EntryFragment
}
eventDivisions {
...EventDivisionFragment
}
fullSchedule {
...ScheduleFragment
}
hideEntries
hideFinals
hideNamesFromJudges
hideScheduledTime
id
location {
...LocationFragment
}
media {
...MediaFragment
}
name
organisation {
...OrganisationFragment
}
organisationId
paymentOptions {
...PaymentOptionsFragment
}
priorityEnabled
registrationOptions {
...RegistrationOptionsFragment
}
restrictions {
...RestrictionFragment
}
scheduledEntryClose
scheduledEntryOpen
seedFromSeriesId
sentEmails {
...EmailFragment
}
series {
...SeriesFragment
}
sponsoredContentEnabled
sponsoredContents {
...SponsoredContentFragment
}
sponsors {
...SponsorFragment
}
status
streams {
...StreamFragment
}
teamLeaderboard {
...EventTeamLeaderboardFragment
}
teams {
...TeamFragment
}
templateId
}
}
Variables
{
"search": "xyz789",
"limit": 123,
"eventLive": false,
"location": EventLocationInput,
"radius": 100
}
Response
{
"data": {
"eventsByName": [
{
"activeEntriesUsers": [User],
"captureFields": [Property],
"competingTeams": [Team],
"config": EventConfig,
"currentHeats": [Heat],
"currentScheduleIndex": 123,
"date": ISO8601DateTime,
"daysWindow": 987,
"entries": [Entry],
"eventDivisions": [EventDivision],
"fullSchedule": Schedule,
"hideEntries": false,
"hideFinals": false,
"hideNamesFromJudges": true,
"hideScheduledTime": true,
"id": 4,
"location": Location,
"media": [Media],
"name": "xyz789",
"organisation": Organisation,
"organisationId": "4",
"paymentOptions": PaymentOptions,
"priorityEnabled": false,
"registrationOptions": RegistrationOptions,
"restrictions": [Restriction],
"scheduledEntryClose": ISO8601DateTime,
"scheduledEntryOpen": ISO8601DateTime,
"seedFromSeriesId": "4",
"sentEmails": [Email],
"series": [Series],
"sponsoredContentEnabled": false,
"sponsoredContents": [SponsoredContent],
"sponsors": [Sponsor],
"status": "scheduled",
"streams": [Stream],
"teamLeaderboard": EventTeamLeaderboard,
"teams": [Team],
"templateId": 4
}
]
}
}
featuredEvents
Description
get the list of featured events
Response
Returns [Event!]!
Example
Query
query featuredEvents {
featuredEvents {
activeEntriesUsers {
...UserFragment
}
captureFields {
...PropertyFragment
}
competingTeams {
...TeamFragment
}
config {
...EventConfigFragment
}
currentHeats {
...HeatFragment
}
currentScheduleIndex
date
daysWindow
entries {
...EntryFragment
}
eventDivisions {
...EventDivisionFragment
}
fullSchedule {
...ScheduleFragment
}
hideEntries
hideFinals
hideNamesFromJudges
hideScheduledTime
id
location {
...LocationFragment
}
media {
...MediaFragment
}
name
organisation {
...OrganisationFragment
}
organisationId
paymentOptions {
...PaymentOptionsFragment
}
priorityEnabled
registrationOptions {
...RegistrationOptionsFragment
}
restrictions {
...RestrictionFragment
}
scheduledEntryClose
scheduledEntryOpen
seedFromSeriesId
sentEmails {
...EmailFragment
}
series {
...SeriesFragment
}
sponsoredContentEnabled
sponsoredContents {
...SponsoredContentFragment
}
sponsors {
...SponsorFragment
}
status
streams {
...StreamFragment
}
teamLeaderboard {
...EventTeamLeaderboardFragment
}
teams {
...TeamFragment
}
templateId
}
}
Response
{
"data": {
"featuredEvents": [
{
"activeEntriesUsers": [User],
"captureFields": [Property],
"competingTeams": [Team],
"config": EventConfig,
"currentHeats": [Heat],
"currentScheduleIndex": 123,
"date": ISO8601DateTime,
"daysWindow": 123,
"entries": [Entry],
"eventDivisions": [EventDivision],
"fullSchedule": Schedule,
"hideEntries": false,
"hideFinals": false,
"hideNamesFromJudges": false,
"hideScheduledTime": false,
"id": "4",
"location": Location,
"media": [Media],
"name": "abc123",
"organisation": Organisation,
"organisationId": "4",
"paymentOptions": PaymentOptions,
"priorityEnabled": true,
"registrationOptions": RegistrationOptions,
"restrictions": [Restriction],
"scheduledEntryClose": ISO8601DateTime,
"scheduledEntryOpen": ISO8601DateTime,
"seedFromSeriesId": 4,
"sentEmails": [Email],
"series": [Series],
"sponsoredContentEnabled": false,
"sponsoredContents": [SponsoredContent],
"sponsors": [Sponsor],
"status": "scheduled",
"streams": [Stream],
"teamLeaderboard": EventTeamLeaderboard,
"teams": [Team],
"templateId": "4"
}
]
}
}
federationAthletes
Description
Get a list of athletes linked to organisation (including descendants for federations)
Response
Returns an OrganisationAthletes!
Example
Query
query federationAthletes(
$id: ID!,
$search: String,
$athleteId: ID,
$page: Int!,
$per: Int!
) {
federationAthletes(
id: $id,
search: $search,
athleteId: $athleteId,
page: $page,
per: $per
) {
athletes {
...AthleteFragment
}
totalCount
}
}
Variables
{
"id": "4",
"search": "xyz789",
"athleteId": 4,
"page": 987,
"per": 987
}
Response
{
"data": {
"federationAthletes": {
"athletes": [Athlete],
"totalCount": 987
}
}
}
federationTeams
Description
Get a list of teams linked to federation
Response
Returns a FederationTeams!
Example
Query
query federationTeams(
$id: ID!,
$search: String,
$teamId: ID,
$page: Int!,
$per: Int!
) {
federationTeams(
id: $id,
search: $search,
teamId: $teamId,
page: $page,
per: $per
) {
teams {
...TeamFragment
}
totalCount
}
}
Variables
{
"id": "4",
"search": "abc123",
"teamId": 4,
"page": 987,
"per": 987
}
Response
{
"data": {
"federationTeams": {
"teams": [Team],
"totalCount": 987
}
}
}
heat
Description
Get a heat by it's id
Example
Query
query heat($id: ID!) {
heat(id: $id) {
competitors {
...CompetitorFragment
}
config {
...HeatConfigFragment
}
contestId
endTime
eventDivision {
...EventDivisionFragment
}
eventDivisionId
group {
...HeatGroupFragment
}
heatDurationMinutes
id
media {
...MediaFragment
}
podium
position
progressions {
...HeatProgressionFragment
}
remainingMillisecondsOnPause
result {
...HeatResultFragment
}
resultWithPending {
...HeatResultFragment
}
resumeTime
round
roundPosition
scheduledTime
startTime
}
}
Variables
{"id": 4}
Response
{
"data": {
"heat": {
"competitors": [Competitor],
"config": HeatConfig,
"contestId": "4",
"endTime": ISO8601DateTime,
"eventDivision": EventDivision,
"eventDivisionId": 4,
"group": HeatGroup,
"heatDurationMinutes": 987,
"id": 4,
"media": [Media],
"podium": "xyz789",
"position": 987,
"progressions": [HeatProgression],
"remainingMillisecondsOnPause": 123,
"result": [HeatResult],
"resultWithPending": [HeatResult],
"resumeTime": ISO8601DateTime,
"round": "abc123",
"roundPosition": 987,
"scheduledTime": ISO8601DateTime,
"startTime": ISO8601DateTime
}
}
}
nfcTag
Description
Get a physical tag by it's id
Response
Returns a PhysicalTag
Example
Query
query nfcTag(
$id: ID,
$humanReadableId: ID
) {
nfcTag(
id: $id,
humanReadableId: $humanReadableId
) {
athlete {
...AthleteFragment
}
athleteId
humanReadableId
id
}
}
Variables
{"id": "4", "humanReadableId": 4}
Response
{
"data": {
"nfcTag": {
"athlete": Athlete,
"athleteId": "4",
"humanReadableId": "4",
"id": "4"
}
}
}
organisation
Description
Get an organisation by it's id, only available for authenticated directors of the organisation
Response
Returns an Organisation
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query organisation($id: ID!) {
organisation(id: $id) {
activePurchases {
...ActivePurchasesFragment
}
contactEmail
customProperties {
...PropertyFragment
}
divisions {
...DivisionFragment
}
docusealEnabled
eventTemplates {
...EventFragment
}
events {
...EventFragment
}
facebook
federatedOrganisationTerm
federatedOrganisations {
...OrganisationFragment
}
federationPointAllocations {
...PointAllocationFragment
}
federationProperties {
...PropertyFragment
}
federationSeries {
...SeriesFragment
}
federationTeams {
...TeamFragment
}
federationTemplates {
...TemplateFragment
}
id
instagram
latestPayment {
...PaymentFragment
}
logo
manageInjuriesEnabled
name
payables {
... on Event {
...EventFragment
}
... on Series {
...SeriesFragment
}
}
paymentsEnabled
paymentsReceived {
...PaymentsFragment
}
series {
...SeriesFragment
}
seriesGroups {
...SeriesGroupFragment
}
shortName
sponsors {
...SponsorFragment
}
sportType
stripeAccountDetails {
...StripeAccountDetailsFragment
}
teamManagersEnabled
transactionFee
useNfc
}
}
Variables
{"id": 4}
Response
{
"data": {
"organisation": {
"activePurchases": ActivePurchases,
"contactEmail": "abc123",
"customProperties": [Property],
"divisions": [Division],
"docusealEnabled": true,
"eventTemplates": [Event],
"events": [Event],
"facebook": "abc123",
"federatedOrganisationTerm": "abc123",
"federatedOrganisations": [Organisation],
"federationPointAllocations": [PointAllocation],
"federationProperties": [Property],
"federationSeries": [Series],
"federationTeams": [Team],
"federationTemplates": [Template],
"id": "4",
"instagram": "abc123",
"latestPayment": Payment,
"logo": "xyz789",
"manageInjuriesEnabled": false,
"name": "abc123",
"payables": [Event],
"paymentsEnabled": true,
"paymentsReceived": Payments,
"series": [Series],
"seriesGroups": [SeriesGroup],
"shortName": "abc123",
"sponsors": [Sponsor],
"sportType": "abc123",
"stripeAccountDetails": StripeAccountDetails,
"teamManagersEnabled": true,
"transactionFee": 123.45,
"useNfc": false
}
}
}
organisationAthletes
Description
Get a list of athletes linked to organisation (including descendants for federations)
Response
Returns an OrganisationAthletes!
Example
Query
query organisationAthletes(
$id: ID!,
$search: String,
$athleteId: ID,
$page: Int!,
$per: Int!
) {
organisationAthletes(
id: $id,
search: $search,
athleteId: $athleteId,
page: $page,
per: $per
) {
athletes {
...AthleteFragment
}
totalCount
}
}
Variables
{
"id": "4",
"search": "abc123",
"athleteId": "4",
"page": 987,
"per": 987
}
Response
{
"data": {
"organisationAthletes": {
"athletes": [Athlete],
"totalCount": 123
}
}
}
organisationByShortName
Description
Get an organisation by it's short name
Response
Returns an Organisation
Arguments
| Name | Description |
|---|---|
shortName - String
|
Example
Query
query organisationByShortName($shortName: String) {
organisationByShortName(shortName: $shortName) {
activePurchases {
...ActivePurchasesFragment
}
contactEmail
customProperties {
...PropertyFragment
}
divisions {
...DivisionFragment
}
docusealEnabled
eventTemplates {
...EventFragment
}
events {
...EventFragment
}
facebook
federatedOrganisationTerm
federatedOrganisations {
...OrganisationFragment
}
federationPointAllocations {
...PointAllocationFragment
}
federationProperties {
...PropertyFragment
}
federationSeries {
...SeriesFragment
}
federationTeams {
...TeamFragment
}
federationTemplates {
...TemplateFragment
}
id
instagram
latestPayment {
...PaymentFragment
}
logo
manageInjuriesEnabled
name
payables {
... on Event {
...EventFragment
}
... on Series {
...SeriesFragment
}
}
paymentsEnabled
paymentsReceived {
...PaymentsFragment
}
series {
...SeriesFragment
}
seriesGroups {
...SeriesGroupFragment
}
shortName
sponsors {
...SponsorFragment
}
sportType
stripeAccountDetails {
...StripeAccountDetailsFragment
}
teamManagersEnabled
transactionFee
useNfc
}
}
Variables
{"shortName": "xyz789"}
Response
{
"data": {
"organisationByShortName": {
"activePurchases": ActivePurchases,
"contactEmail": "abc123",
"customProperties": [Property],
"divisions": [Division],
"docusealEnabled": false,
"eventTemplates": [Event],
"events": [Event],
"facebook": "xyz789",
"federatedOrganisationTerm": "abc123",
"federatedOrganisations": [Organisation],
"federationPointAllocations": [PointAllocation],
"federationProperties": [Property],
"federationSeries": [Series],
"federationTeams": [Team],
"federationTemplates": [Template],
"id": 4,
"instagram": "xyz789",
"latestPayment": Payment,
"logo": "xyz789",
"manageInjuriesEnabled": true,
"name": "xyz789",
"payables": [Event],
"paymentsEnabled": true,
"paymentsReceived": Payments,
"series": [Series],
"seriesGroups": [SeriesGroup],
"shortName": "abc123",
"sponsors": [Sponsor],
"sportType": "xyz789",
"stripeAccountDetails": StripeAccountDetails,
"teamManagersEnabled": false,
"transactionFee": 987.65,
"useNfc": false
}
}
}
organisationUsers
Description
Get a list of judges and directors linked to organisation
Example
Query
query organisationUsers($id: ID!) {
organisationUsers(id: $id) {
athletes {
...AthleteFragment
}
competitors {
...CompetitorFragment
}
email
entries {
...EntryFragment
}
eventAthletes {
...AthleteFragment
}
eventEmails {
...EmailFragment
}
id
image
name
pendingPayments {
...PaymentFragment
}
phone
properties
role
unfinishedEvents {
...EventFragment
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"organisationUsers": [
{
"athletes": [Athlete],
"competitors": [Competitor],
"email": "abc123",
"entries": [Entry],
"eventAthletes": [Athlete],
"eventEmails": [Email],
"id": 4,
"image": "abc123",
"name": "xyz789",
"pendingPayments": [Payment],
"phone": "xyz789",
"properties": {},
"role": "abc123",
"unfinishedEvents": [Event]
}
]
}
}
organisationsByName
Description
get a list of organisations that contain the search string name or short name
Response
Returns [Organisation!]
Arguments
| Name | Description |
|---|---|
search - String!
|
|
limit - Int
|
|
location - EventLocationInput
|
Location to search by. Provide either country or coordinates. |
radius - Float
|
Radius in kilometers to search within when providing coordinates. Default = 100.0 |
Example
Query
query organisationsByName(
$search: String!,
$limit: Int,
$location: EventLocationInput,
$radius: Float
) {
organisationsByName(
search: $search,
limit: $limit,
location: $location,
radius: $radius
) {
activePurchases {
...ActivePurchasesFragment
}
contactEmail
customProperties {
...PropertyFragment
}
divisions {
...DivisionFragment
}
docusealEnabled
eventTemplates {
...EventFragment
}
events {
...EventFragment
}
facebook
federatedOrganisationTerm
federatedOrganisations {
...OrganisationFragment
}
federationPointAllocations {
...PointAllocationFragment
}
federationProperties {
...PropertyFragment
}
federationSeries {
...SeriesFragment
}
federationTeams {
...TeamFragment
}
federationTemplates {
...TemplateFragment
}
id
instagram
latestPayment {
...PaymentFragment
}
logo
manageInjuriesEnabled
name
payables {
... on Event {
...EventFragment
}
... on Series {
...SeriesFragment
}
}
paymentsEnabled
paymentsReceived {
...PaymentsFragment
}
series {
...SeriesFragment
}
seriesGroups {
...SeriesGroupFragment
}
shortName
sponsors {
...SponsorFragment
}
sportType
stripeAccountDetails {
...StripeAccountDetailsFragment
}
teamManagersEnabled
transactionFee
useNfc
}
}
Variables
{
"search": "xyz789",
"limit": 123,
"location": EventLocationInput,
"radius": 100
}
Response
{
"data": {
"organisationsByName": [
{
"activePurchases": ActivePurchases,
"contactEmail": "xyz789",
"customProperties": [Property],
"divisions": [Division],
"docusealEnabled": true,
"eventTemplates": [Event],
"events": [Event],
"facebook": "xyz789",
"federatedOrganisationTerm": "abc123",
"federatedOrganisations": [Organisation],
"federationPointAllocations": [PointAllocation],
"federationProperties": [Property],
"federationSeries": [Series],
"federationTeams": [Team],
"federationTemplates": [Template],
"id": 4,
"instagram": "xyz789",
"latestPayment": Payment,
"logo": "abc123",
"manageInjuriesEnabled": true,
"name": "abc123",
"payables": [Event],
"paymentsEnabled": false,
"paymentsReceived": Payments,
"series": [Series],
"seriesGroups": [SeriesGroup],
"shortName": "abc123",
"sponsors": [Sponsor],
"sportType": "abc123",
"stripeAccountDetails": StripeAccountDetails,
"teamManagersEnabled": false,
"transactionFee": 987.65,
"useNfc": true
}
]
}
}
payment
Description
Get a payment by id. Restricted to owners of the payment, which includes the payer and the payee
Example
Query
query payment($id: ID!) {
payment(id: $id) {
amount
chargeId
createdAt
currency
directCharge
entries {
...EntryFragment
}
fee
id
intentId
payable {
... on Event {
...EventFragment
}
... on Series {
...SeriesFragment
}
}
purchasedOptions {
...PurchasedOptionsFragment
}
refunds {
...RefundFragment
}
registrationError
status
user {
...UserFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"payment": {
"amount": 123,
"chargeId": "xyz789",
"createdAt": ISO8601DateTime,
"currency": "xyz789",
"directCharge": false,
"entries": [Entry],
"fee": 987,
"id": "4",
"intentId": "xyz789",
"payable": Event,
"purchasedOptions": PurchasedOptions,
"refunds": [Refund],
"registrationError": "abc123",
"status": "abc123",
"user": User
}
}
}
pricingData
Description
Get the pricing data
Response
Returns a PricingData!
Example
Query
query pricingData {
pricingData {
addOnBaselinePrices {
...AddOnBaselinePriceFragment
}
country
creditBaselinePrices {
...CreditBaselinePriceFragment
}
currency
marketFactors {
...MarketFactorFragment
}
region
sizeFactors {
...SizeFactorFragment
}
volumeDiscounts
}
}
Response
{
"data": {
"pricingData": {
"addOnBaselinePrices": [AddOnBaselinePrice],
"country": "xyz789",
"creditBaselinePrices": [CreditBaselinePrice],
"currency": "xyz789",
"marketFactors": [MarketFactor],
"region": "xyz789",
"sizeFactors": [SizeFactor],
"volumeDiscounts": [987.65]
}
}
}
randomAd
Description
Fetch the first ad for a given organisation
Example
Query
query randomAd(
$organisationId: ID!,
$placement: String
) {
randomAd(
organisationId: $organisationId,
placement: $placement
) {
bgColor
callToAction
callToActionColor
copy
id
logo
tag
url
}
}
Variables
{
"organisationId": "4",
"placement": "abc123"
}
Response
{
"data": {
"randomAd": {
"bgColor": "xyz789",
"callToAction": "abc123",
"callToActionColor": "abc123",
"copy": "xyz789",
"id": "4",
"logo": "xyz789",
"tag": "xyz789",
"url": "abc123"
}
}
}
series
Description
Get a series by it's id
Example
Query
query series($id: ID!) {
series(id: $id) {
allDivisions {
...DivisionFragment
}
allMembershipsByEvents {
...MembershipFragment
}
athleteRankingResults {
...AthleteRankingResultFragment
}
availableRankingFilters
captureFields {
...PropertyFragment
}
childSeries {
...SeriesFragment
}
divisions {
...DivisionFragment
}
events {
...EventFragment
}
exclusive
id
membershipDivisions {
...DivisionFragment
}
name
options {
...OptionsFragment
}
organisation {
...OrganisationFragment
}
organisationId
paginatedMemberships {
...MembershipsFragment
}
parentSeries {
...SeriesFragment
}
pointAllocationId
rankingOptions {
...RankingOptionsFragment
}
rankings {
...SeriesRankFragment
}
rankingsDisplayProperty
rankingsDivisions {
...DivisionFragment
}
registrationOptions {
...RegistrationOptionsFragment
}
results {
...ResultFragment
}
resultsToCount
seriesGroupId
signOnStatus
}
}
Variables
{"id": "4"}
Response
{
"data": {
"series": {
"allDivisions": [Division],
"allMembershipsByEvents": [Membership],
"athleteRankingResults": AthleteRankingResult,
"availableRankingFilters": ["xyz789"],
"captureFields": [Property],
"childSeries": [Series],
"divisions": [Division],
"events": [Event],
"exclusive": false,
"id": 4,
"membershipDivisions": [Division],
"name": "abc123",
"options": Options,
"organisation": Organisation,
"organisationId": "4",
"paginatedMemberships": Memberships,
"parentSeries": Series,
"pointAllocationId": "4",
"rankingOptions": RankingOptions,
"rankings": [SeriesRank],
"rankingsDisplayProperty": {},
"rankingsDivisions": [Division],
"registrationOptions": RegistrationOptions,
"results": [Result],
"resultsToCount": {},
"seriesGroupId": "4",
"signOnStatus": "closed"
}
}
}
seriesRankingRuleOverride
Description
Get ranking rule overrides by series id and rule
Response
Returns [RankingRuleOverride!]
Example
Query
query seriesRankingRuleOverride(
$seriesId: ID!,
$rule: String!
) {
seriesRankingRuleOverride(
seriesId: $seriesId,
rule: $rule
) {
athlete {
...AthleteFragment
}
division {
...DivisionFragment
}
id
override
rule
series {
...SeriesFragment
}
}
}
Variables
{"seriesId": 4, "rule": "abc123"}
Response
{
"data": {
"seriesRankingRuleOverride": [
{
"athlete": Athlete,
"division": Division,
"id": "4",
"override": 123,
"rule": "abc123",
"series": Series
}
]
}
}
shortNameAvailable
Description
Check if a short name candidate is available for an organisation
Example
Query
query shortNameAvailable(
$shortName: String,
$organisationId: ID
) {
shortNameAvailable(
shortName: $shortName,
organisationId: $organisationId
)
}
Variables
{
"shortName": "abc123",
"organisationId": "4"
}
Response
{"data": {"shortNameAvailable": true}}
stripeClientId
Description
Get the public Stripe client id for the current environment
Response
Returns a String!
Example
Query
query stripeClientId {
stripeClientId
}
Response
{"data": {"stripeClientId": "xyz789"}}
timezone
Description
get the timezone for a given longitude, latitude and date
Response
Returns a Timezone
Arguments
| Name | Description |
|---|---|
longitude - Float!
|
|
latitude - Float!
|
|
date - ISO8601DateTime
|
Example
Query
query timezone(
$longitude: Float!,
$latitude: Float!,
$date: ISO8601DateTime
) {
timezone(
longitude: $longitude,
latitude: $latitude,
date: $date
) {
date
name
utcOffsetMinutes
}
}
Variables
{
"longitude": 987.65,
"latitude": 987.65,
"date": ISO8601DateTime
}
Response
{
"data": {
"timezone": {
"date": ISO8601Date,
"name": "xyz789",
"utcOffsetMinutes": 987
}
}
}
user
Description
Get the current user
Response
Returns a User
Example
Query
query user {
user {
athletes {
...AthleteFragment
}
competitors {
...CompetitorFragment
}
email
entries {
...EntryFragment
}
eventAthletes {
...AthleteFragment
}
eventEmails {
...EmailFragment
}
id
image
name
pendingPayments {
...PaymentFragment
}
phone
properties
role
unfinishedEvents {
...EventFragment
}
}
}
Response
{
"data": {
"user": {
"athletes": [Athlete],
"competitors": [Competitor],
"email": "xyz789",
"entries": [Entry],
"eventAthletes": [Athlete],
"eventEmails": [Email],
"id": "4",
"image": "abc123",
"name": "abc123",
"pendingPayments": [Payment],
"phone": "xyz789",
"properties": {},
"role": "abc123",
"unfinishedEvents": [Event]
}
}
}
validateRestrictions
Description
Validate restrictions by IDs
Response
Returns [RestrictionValidationResult!]!
Arguments
| Name | Description |
|---|---|
restrictionIds - [ID!]!
|
|
athlete - AthleteInput!
|
Example
Query
query validateRestrictions(
$restrictionIds: [ID!]!,
$athlete: AthleteInput!
) {
validateRestrictions(
restrictionIds: $restrictionIds,
athlete: $athlete
) {
message
restrictableId
restrictableType
restrictionConfig {
...RestrictionConfigFragment
}
restrictionId
restrictionType
valid
}
}
Variables
{"restrictionIds": [4], "athlete": AthleteInput}
Response
{
"data": {
"validateRestrictions": [
{
"message": "xyz789",
"restrictableId": "abc123",
"restrictableType": "xyz789",
"restrictionConfig": RestrictionConfig,
"restrictionId": "4",
"restrictionType": "abc123",
"valid": false
}
]
}
}
Mutations
addAthleteToHeat
Response
Returns an AddAthleteToHeatPayload
Arguments
| Name | Description |
|---|---|
input - AddAthleteToHeatInput!
|
Parameters for AddAthleteToHeat |
Example
Query
mutation addAthleteToHeat($input: AddAthleteToHeatInput!) {
addAthleteToHeat(input: $input) {
clientMutationId
heat {
...HeatFragment
}
}
}
Variables
{"input": AddAthleteToHeatInput}
Response
{
"data": {
"addAthleteToHeat": {
"clientMutationId": "abc123",
"heat": Heat
}
}
}
addHeatToRound
Response
Returns an AddHeatToRoundPayload
Arguments
| Name | Description |
|---|---|
input - AddHeatToRoundInput!
|
Parameters for AddHeatToRound |
Example
Query
mutation addHeatToRound($input: AddHeatToRoundInput!) {
addHeatToRound(input: $input) {
clientMutationId
heat {
...HeatFragment
}
}
}
Variables
{"input": AddHeatToRoundInput}
Response
{
"data": {
"addHeatToRound": {
"clientMutationId": "xyz789",
"heat": Heat
}
}
}
addPermissionToRecord
Response
Returns an AddPermissionToRecordPayload
Arguments
| Name | Description |
|---|---|
input - AddPermissionToRecordInput!
|
Parameters for AddPermissionToRecord |
Example
Query
mutation addPermissionToRecord($input: AddPermissionToRecordInput!) {
addPermissionToRecord(input: $input) {
clientMutationId
record {
... on Team {
...TeamFragment
}
}
user {
...UserFragment
}
}
}
Variables
{"input": AddPermissionToRecordInput}
Response
{
"data": {
"addPermissionToRecord": {
"clientMutationId": "abc123",
"record": Team,
"user": User
}
}
}
addPriority
Response
Returns an AddPriorityPayload
Arguments
| Name | Description |
|---|---|
input - AddPriorityInput!
|
Parameters for AddPriority |
Example
Query
mutation addPriority($input: AddPriorityInput!) {
addPriority(input: $input) {
clientMutationId
heat {
...HeatFragment
}
}
}
Variables
{"input": AddPriorityInput}
Response
{
"data": {
"addPriority": {
"clientMutationId": "abc123",
"heat": Heat
}
}
}
addRankingRuleOverride
Description
creates a ranking rule override for an athlete.
Response
Returns an AddRankingRuleOverridePayload
Arguments
| Name | Description |
|---|---|
input - AddRankingRuleOverrideInput!
|
Parameters for AddRankingRuleOverride |
Example
Query
mutation addRankingRuleOverride($input: AddRankingRuleOverrideInput!) {
addRankingRuleOverride(input: $input) {
clientMutationId
rankingRuleOverride {
...RankingRuleOverrideFragment
}
}
}
Variables
{"input": AddRankingRuleOverrideInput}
Response
{
"data": {
"addRankingRuleOverride": {
"clientMutationId": "abc123",
"rankingRuleOverride": RankingRuleOverride
}
}
}
addRound
Response
Returns an AddRoundPayload
Arguments
| Name | Description |
|---|---|
input - AddRoundInput!
|
Parameters for AddRound |
Example
Query
mutation addRound($input: AddRoundInput!) {
addRound(input: $input) {
clientMutationId
eventDivision {
...EventDivisionFragment
}
}
}
Variables
{"input": AddRoundInput}
Response
{
"data": {
"addRound": {
"clientMutationId": "xyz789",
"eventDivision": EventDivision
}
}
}
addSponsor
Description
adds a sponsor
Response
Returns an AddSponsorPayload
Arguments
| Name | Description |
|---|---|
input - AddSponsorInput!
|
Parameters for AddSponsor |
Example
Query
mutation addSponsor($input: AddSponsorInput!) {
addSponsor(input: $input) {
clientMutationId
sponsor {
...SponsorFragment
}
}
}
Variables
{"input": AddSponsorInput}
Response
{
"data": {
"addSponsor": {
"clientMutationId": "abc123",
"sponsor": Sponsor
}
}
}
addUserToAthlete
Response
Returns an AddUserToAthletePayload
Arguments
| Name | Description |
|---|---|
input - AddUserToAthleteInput!
|
Parameters for AddUserToAthlete |
Example
Query
mutation addUserToAthlete($input: AddUserToAthleteInput!) {
addUserToAthlete(input: $input) {
clientMutationId
user {
...UserFragment
}
}
}
Variables
{"input": AddUserToAthleteInput}
Response
{
"data": {
"addUserToAthlete": {
"clientMutationId": "xyz789",
"user": User
}
}
}
addUserToOrganisation
Response
Returns an AddUserToOrganisationPayload
Arguments
| Name | Description |
|---|---|
input - AddUserToOrganisationInput!
|
Parameters for AddUserToOrganisation |
Example
Query
mutation addUserToOrganisation($input: AddUserToOrganisationInput!) {
addUserToOrganisation(input: $input) {
clientMutationId
user {
...UserFragment
}
}
}
Variables
{"input": AddUserToOrganisationInput}
Response
{
"data": {
"addUserToOrganisation": {
"clientMutationId": "abc123",
"user": User
}
}
}
appendChildContest
Response
Returns an AppendChildContestPayload
Arguments
| Name | Description |
|---|---|
input - AppendChildContestInput!
|
Parameters for AppendChildContest |
Example
Query
mutation appendChildContest($input: AppendChildContestInput!) {
appendChildContest(input: $input) {
clientMutationId
eventDivision {
...EventDivisionFragment
}
}
}
Variables
{"input": AppendChildContestInput}
Response
{
"data": {
"appendChildContest": {
"clientMutationId": "abc123",
"eventDivision": EventDivision
}
}
}
archiveOrganisationProperty
Response
Returns an ArchiveOrganisationPropertyPayload
Arguments
| Name | Description |
|---|---|
input - ArchiveOrganisationPropertyInput!
|
Parameters for ArchiveOrganisationProperty |
Example
Query
mutation archiveOrganisationProperty($input: ArchiveOrganisationPropertyInput!) {
archiveOrganisationProperty(input: $input) {
clientMutationId
property {
...PropertyFragment
}
}
}
Variables
{"input": ArchiveOrganisationPropertyInput}
Response
{
"data": {
"archiveOrganisationProperty": {
"clientMutationId": "abc123",
"property": Property
}
}
}
cancelEntry
Description
Cancel an entry in a division
Response
Returns a CancelEntryPayload
Arguments
| Name | Description |
|---|---|
input - CancelEntryInput!
|
Parameters for CancelEntry |
Example
Query
mutation cancelEntry($input: CancelEntryInput!) {
cancelEntry(input: $input) {
clientMutationId
entry {
...EntryFragment
}
}
}
Variables
{"input": CancelEntryInput}
Response
{
"data": {
"cancelEntry": {
"clientMutationId": "abc123",
"entry": Entry
}
}
}
confirmEntries
Description
Confirm the entries
Response
Returns a ConfirmEntriesPayload
Arguments
| Name | Description |
|---|---|
input - ConfirmEntriesInput!
|
Parameters for ConfirmEntries |
Example
Query
mutation confirmEntries($input: ConfirmEntriesInput!) {
confirmEntries(input: $input) {
clientMutationId
entries {
...EntryFragment
}
rejectedEntries {
...EntryFragment
}
}
}
Variables
{"input": ConfirmEntriesInput}
Response
{
"data": {
"confirmEntries": {
"clientMutationId": "xyz789",
"entries": [Entry],
"rejectedEntries": [Entry]
}
}
}
copyEvent
Description
Creates a new event from copy of an event inside the organisation referenced on the organisationId argument. The caller must have events/director scope permissions for that organisation.
Response
Returns a CopyEventPayload
Arguments
| Name | Description |
|---|---|
input - CopyEventInput!
|
Parameters for CopyEvent |
Example
Query
mutation copyEvent($input: CopyEventInput!) {
copyEvent(input: $input) {
clientMutationId
event {
...EventFragment
}
}
}
Variables
{"input": CopyEventInput}
Response
{
"data": {
"copyEvent": {
"clientMutationId": "xyz789",
"event": Event
}
}
}
createEntries
Description
Creates the provided entries in the event associated to the eventId argument. The caller must have events/director scope permissions for that event.
Response
Returns a CreateEntriesPayload
Arguments
| Name | Description |
|---|---|
input - CreateEntriesInput!
|
Parameters for CreateEntries |
Example
Query
mutation createEntries($input: CreateEntriesInput!) {
createEntries(input: $input) {
clientMutationId
entries {
...EntryFragment
}
}
}
Variables
{"input": CreateEntriesInput}
Response
{
"data": {
"createEntries": {
"clientMutationId": "abc123",
"entries": [Entry]
}
}
}
createEvent
Description
Creates a new event inside the organisation referenced on the organisationId argument. The caller must have events/director scope permissions for that organisation.
Response
Returns a CreateEventPayload
Arguments
| Name | Description |
|---|---|
input - CreateEventInput!
|
Parameters for CreateEvent |
Example
Query
mutation createEvent($input: CreateEventInput!) {
createEvent(input: $input) {
clientMutationId
event {
...EventFragment
}
}
}
Variables
{"input": CreateEventInput}
Response
{
"data": {
"createEvent": {
"clientMutationId": "xyz789",
"event": Event
}
}
}
createMembership
Description
creates a membership for an athlete.
Response
Returns a CreateMembershipPayload
Arguments
| Name | Description |
|---|---|
input - CreateMembershipInput!
|
Parameters for CreateMembership |
Example
Query
mutation createMembership($input: CreateMembershipInput!) {
createMembership(input: $input) {
clientMutationId
membership {
...MembershipFragment
}
}
}
Variables
{"input": CreateMembershipInput}
Response
{
"data": {
"createMembership": {
"clientMutationId": "abc123",
"membership": Membership
}
}
}
createOrganisation
Response
Returns a CreateOrganisationPayload
Arguments
| Name | Description |
|---|---|
input - CreateOrganisationInput!
|
Parameters for CreateOrganisation |
Example
Query
mutation createOrganisation($input: CreateOrganisationInput!) {
createOrganisation(input: $input) {
clientMutationId
organisation {
...OrganisationFragment
}
}
}
Variables
{"input": CreateOrganisationInput}
Response
{
"data": {
"createOrganisation": {
"clientMutationId": "xyz789",
"organisation": Organisation
}
}
}
createOrganisationProperty
Response
Returns a CreateOrganisationPropertyPayload
Arguments
| Name | Description |
|---|---|
input - CreateOrganisationPropertyInput!
|
Parameters for CreateOrganisationProperty |
Example
Query
mutation createOrganisationProperty($input: CreateOrganisationPropertyInput!) {
createOrganisationProperty(input: $input) {
clientMutationId
property {
...PropertyFragment
}
}
}
Variables
{"input": CreateOrganisationPropertyInput}
Response
{
"data": {
"createOrganisationProperty": {
"clientMutationId": "abc123",
"property": Property
}
}
}
createSeriesGroup
Response
Returns a CreateSeriesGroupPayload
Arguments
| Name | Description |
|---|---|
input - CreateSeriesGroupInput!
|
Parameters for CreateSeriesGroup |
Example
Query
mutation createSeriesGroup($input: CreateSeriesGroupInput!) {
createSeriesGroup(input: $input) {
clientMutationId
seriesGroup {
...SeriesGroupFragment
}
}
}
Variables
{"input": CreateSeriesGroupInput}
Response
{
"data": {
"createSeriesGroup": {
"clientMutationId": "abc123",
"seriesGroup": SeriesGroup
}
}
}
deleteContest
Response
Returns a DeleteContestPayload
Arguments
| Name | Description |
|---|---|
input - DeleteContestInput!
|
Parameters for DeleteContest |
Example
Query
mutation deleteContest($input: DeleteContestInput!) {
deleteContest(input: $input) {
clientMutationId
eventDivision {
...EventDivisionFragment
}
}
}
Variables
{"input": DeleteContestInput}
Response
{
"data": {
"deleteContest": {
"clientMutationId": "xyz789",
"eventDivision": EventDivision
}
}
}
deleteHeat
Response
Returns a DeleteHeatPayload
Arguments
| Name | Description |
|---|---|
input - DeleteHeatInput!
|
Parameters for DeleteHeat |
Example
Query
mutation deleteHeat($input: DeleteHeatInput!) {
deleteHeat(input: $input) {
clientMutationId
eventDivision {
...EventDivisionFragment
}
heat {
...HeatFragment
}
}
}
Variables
{"input": DeleteHeatInput}
Response
{
"data": {
"deleteHeat": {
"clientMutationId": "xyz789",
"eventDivision": EventDivision,
"heat": Heat
}
}
}
deleteInjury
Description
delete an injury for an athlete
Response
Returns a DeleteInjuryPayload
Arguments
| Name | Description |
|---|---|
input - DeleteInjuryInput!
|
Parameters for DeleteInjury |
Example
Query
mutation deleteInjury($input: DeleteInjuryInput!) {
deleteInjury(input: $input) {
clientMutationId
injury {
...InjuryFragment
}
}
}
Variables
{"input": DeleteInjuryInput}
Response
{
"data": {
"deleteInjury": {
"clientMutationId": "abc123",
"injury": Injury
}
}
}
deleteMembership
Description
delete a membership
Response
Returns a DeleteMembershipPayload
Arguments
| Name | Description |
|---|---|
input - DeleteMembershipInput!
|
Parameters for DeleteMembership |
Example
Query
mutation deleteMembership($input: DeleteMembershipInput!) {
deleteMembership(input: $input) {
clientMutationId
membership {
...MembershipFragment
}
}
}
Variables
{"input": DeleteMembershipInput}
Response
{
"data": {
"deleteMembership": {
"clientMutationId": "abc123",
"membership": Membership
}
}
}
deleteRankingRuleOverride
Description
delete a ranking rule ovveride for an athlete
Response
Returns a DeleteRankingRuleOverridePayload
Arguments
| Name | Description |
|---|---|
input - DeleteRankingRuleOverrideInput!
|
Parameters for DeleteRankingRuleOverride |
Example
Query
mutation deleteRankingRuleOverride($input: DeleteRankingRuleOverrideInput!) {
deleteRankingRuleOverride(input: $input) {
clientMutationId
rankingRuleOverride {
...RankingRuleOverrideFragment
}
}
}
Variables
{"input": DeleteRankingRuleOverrideInput}
Response
{
"data": {
"deleteRankingRuleOverride": {
"clientMutationId": "xyz789",
"rankingRuleOverride": RankingRuleOverride
}
}
}
deleteSeries
Description
Soft-delete a series
Response
Returns a DeleteSeriesPayload
Arguments
| Name | Description |
|---|---|
input - DeleteSeriesInput!
|
Parameters for DeleteSeries |
Example
Query
mutation deleteSeries($input: DeleteSeriesInput!) {
deleteSeries(input: $input) {
clientMutationId
series {
...SeriesFragment
}
}
}
Variables
{"input": DeleteSeriesInput}
Response
{
"data": {
"deleteSeries": {
"clientMutationId": "abc123",
"series": Series
}
}
}
excludeAthleteFromRankings
Description
Excludes an athlete from all series rankings for the event division
Response
Returns an ExcludeAthleteFromRankingsPayload
Arguments
| Name | Description |
|---|---|
input - ExcludeAthleteFromRankingsInput!
|
Parameters for ExcludeAthleteFromRankings |
Example
Query
mutation excludeAthleteFromRankings($input: ExcludeAthleteFromRankingsInput!) {
excludeAthleteFromRankings(input: $input) {
clientMutationId
eventDivision {
...EventDivisionFragment
}
}
}
Variables
{"input": ExcludeAthleteFromRankingsInput}
Response
{
"data": {
"excludeAthleteFromRankings": {
"clientMutationId": "xyz789",
"eventDivision": EventDivision
}
}
}
linkTagToAthlete
Response
Returns a LinkTagToAthletePayload
Arguments
| Name | Description |
|---|---|
input - LinkTagToAthleteInput!
|
Parameters for LinkTagToAthlete |
Example
Query
mutation linkTagToAthlete($input: LinkTagToAthleteInput!) {
linkTagToAthlete(input: $input) {
clientMutationId
tag {
...PhysicalTagFragment
}
}
}
Variables
{"input": LinkTagToAthleteInput}
Response
{
"data": {
"linkTagToAthlete": {
"clientMutationId": "abc123",
"tag": PhysicalTag
}
}
}
logInjury
Description
log an injury for an athlete
Response
Returns a LogInjuryPayload
Arguments
| Name | Description |
|---|---|
input - LogInjuryInput!
|
Parameters for LogInjury |
Example
Query
mutation logInjury($input: LogInjuryInput!) {
logInjury(input: $input) {
clientMutationId
injury {
...InjuryFragment
}
}
}
Variables
{"input": LogInjuryInput}
Response
{
"data": {
"logInjury": {
"clientMutationId": "xyz789",
"injury": Injury
}
}
}
mergeAthletes
Response
Returns a MergeAthletesPayload
Arguments
| Name | Description |
|---|---|
input - MergeAthletesInput!
|
Parameters for MergeAthletes |
Example
Query
mutation mergeAthletes($input: MergeAthletesInput!) {
mergeAthletes(input: $input) {
athlete {
...AthleteFragment
}
clientMutationId
}
}
Variables
{"input": MergeAthletesInput}
Response
{
"data": {
"mergeAthletes": {
"athlete": Athlete,
"clientMutationId": "abc123"
}
}
}
moveHeatItems
Response
Returns a MoveHeatItemsPayload
Arguments
| Name | Description |
|---|---|
input - MoveHeatItemsInput!
|
Parameters for MoveHeatItems |
Example
Query
mutation moveHeatItems($input: MoveHeatItemsInput!) {
moveHeatItems(input: $input) {
clientMutationId
heats {
...HeatFragment
}
}
}
Variables
{"input": MoveHeatItemsInput}
Response
{
"data": {
"moveHeatItems": {
"clientMutationId": "xyz789",
"heats": [Heat]
}
}
}
refundPayment
Response
Returns a RefundPaymentPayload
Arguments
| Name | Description |
|---|---|
input - RefundPaymentInput!
|
Parameters for RefundPayment |
Example
Query
mutation refundPayment($input: RefundPaymentInput!) {
refundPayment(input: $input) {
clientMutationId
errors
payment {
...PaymentFragment
}
}
}
Variables
{"input": RefundPaymentInput}
Response
{
"data": {
"refundPayment": {
"clientMutationId": "abc123",
"errors": "xyz789",
"payment": Payment
}
}
}
removeAthleteFromHeat
Response
Returns a RemoveAthleteFromHeatPayload
Arguments
| Name | Description |
|---|---|
input - RemoveAthleteFromHeatInput!
|
Parameters for RemoveAthleteFromHeat |
Example
Query
mutation removeAthleteFromHeat($input: RemoveAthleteFromHeatInput!) {
removeAthleteFromHeat(input: $input) {
clientMutationId
heat {
...HeatFragment
}
}
}
Variables
{"input": RemoveAthleteFromHeatInput}
Response
{
"data": {
"removeAthleteFromHeat": {
"clientMutationId": "abc123",
"heat": Heat
}
}
}
removePermissionFromRecord
Response
Returns a RemovePermissionFromRecordPayload
Arguments
| Name | Description |
|---|---|
input - RemovePermissionFromRecordInput!
|
Parameters for RemovePermissionFromRecord |
Example
Query
mutation removePermissionFromRecord($input: RemovePermissionFromRecordInput!) {
removePermissionFromRecord(input: $input) {
clientMutationId
team {
...TeamFragment
}
}
}
Variables
{"input": RemovePermissionFromRecordInput}
Response
{
"data": {
"removePermissionFromRecord": {
"clientMutationId": "xyz789",
"team": Team
}
}
}
removePriority
Response
Returns a RemovePriorityPayload
Arguments
| Name | Description |
|---|---|
input - RemovePriorityInput!
|
Parameters for RemovePriority |
Example
Query
mutation removePriority($input: RemovePriorityInput!) {
removePriority(input: $input) {
clientMutationId
heat {
...HeatFragment
}
}
}
Variables
{"input": RemovePriorityInput}
Response
{
"data": {
"removePriority": {
"clientMutationId": "xyz789",
"heat": Heat
}
}
}
removeUserFromOrganisation
Response
Returns a RemoveUserFromOrganisationPayload
Arguments
| Name | Description |
|---|---|
input - RemoveUserFromOrganisationInput!
|
Parameters for RemoveUserFromOrganisation |
Example
Query
mutation removeUserFromOrganisation($input: RemoveUserFromOrganisationInput!) {
removeUserFromOrganisation(input: $input) {
clientMutationId
user {
...UserFragment
}
}
}
Variables
{"input": RemoveUserFromOrganisationInput}
Response
{
"data": {
"removeUserFromOrganisation": {
"clientMutationId": "abc123",
"user": User
}
}
}
resetUserPassword
Response
Returns a ResetUserPasswordPayload
Arguments
| Name | Description |
|---|---|
input - ResetUserPasswordInput!
|
Parameters for ResetUserPassword |
Example
Query
mutation resetUserPassword($input: ResetUserPasswordInput!) {
resetUserPassword(input: $input) {
clientMutationId
user {
...UserFragment
}
}
}
Variables
{"input": ResetUserPasswordInput}
Response
{
"data": {
"resetUserPassword": {
"clientMutationId": "abc123",
"user": User
}
}
}
saveEventDivisionAsTemplate
Description
Saves the configurations of the eventDivision as a new template with the provided name on the provided organisation. The caller must have organisations/manage scope permissions for that organisation and events/director for the event the eventDivision belongs to.
Response
Returns a SaveEventDivisionAsTemplatePayload
Arguments
| Name | Description |
|---|---|
input - SaveEventDivisionAsTemplateInput!
|
Parameters for SaveEventDivisionAsTemplate |
Example
Query
mutation saveEventDivisionAsTemplate($input: SaveEventDivisionAsTemplateInput!) {
saveEventDivisionAsTemplate(input: $input) {
clientMutationId
eventDivision {
...EventDivisionFragment
}
}
}
Variables
{"input": SaveEventDivisionAsTemplateInput}
Response
{
"data": {
"saveEventDivisionAsTemplate": {
"clientMutationId": "xyz789",
"eventDivision": EventDivision
}
}
}
sendEventEmail
Description
Send an event email to a list of recipients
Response
Returns a SendEventEmailPayload
Arguments
| Name | Description |
|---|---|
input - SendEventEmailInput!
|
Parameters for SendEventEmail |
Example
Query
mutation sendEventEmail($input: SendEventEmailInput!) {
sendEventEmail(input: $input) {
clientMutationId
event {
...EventFragment
}
}
}
Variables
{"input": SendEventEmailInput}
Response
{
"data": {
"sendEventEmail": {
"clientMutationId": "xyz789",
"event": Event
}
}
}
suspendPriority
Response
Returns a SuspendPriorityPayload
Arguments
| Name | Description |
|---|---|
input - SuspendPriorityInput!
|
Parameters for SuspendPriority |
Example
Query
mutation suspendPriority($input: SuspendPriorityInput!) {
suspendPriority(input: $input) {
clientMutationId
heat {
...HeatFragment
}
}
}
Variables
{"input": SuspendPriorityInput}
Response
{
"data": {
"suspendPriority": {
"clientMutationId": "xyz789",
"heat": Heat
}
}
}
ungroupSeriesGroup
Response
Returns an UngroupSeriesGroupPayload
Arguments
| Name | Description |
|---|---|
input - UngroupSeriesGroupInput!
|
Parameters for UngroupSeriesGroup |
Example
Query
mutation ungroupSeriesGroup($input: UngroupSeriesGroupInput!) {
ungroupSeriesGroup(input: $input) {
clientMutationId
organisation {
...OrganisationFragment
}
}
}
Variables
{"input": UngroupSeriesGroupInput}
Response
{
"data": {
"ungroupSeriesGroup": {
"clientMutationId": "xyz789",
"organisation": Organisation
}
}
}
unsuspendPriority
Response
Returns an UnsuspendPriorityPayload
Arguments
| Name | Description |
|---|---|
input - UnsuspendPriorityInput!
|
Parameters for UnsuspendPriority |
Example
Query
mutation unsuspendPriority($input: UnsuspendPriorityInput!) {
unsuspendPriority(input: $input) {
clientMutationId
heat {
...HeatFragment
}
}
}
Variables
{"input": UnsuspendPriorityInput}
Response
{
"data": {
"unsuspendPriority": {
"clientMutationId": "abc123",
"heat": Heat
}
}
}
updateAthlete
Response
Returns an UpdateAthletePayload
Arguments
| Name | Description |
|---|---|
input - UpdateAthleteInput!
|
Parameters for UpdateAthlete |
Example
Query
mutation updateAthlete($input: UpdateAthleteInput!) {
updateAthlete(input: $input) {
athlete {
...AthleteFragment
}
clientMutationId
}
}
Variables
{"input": UpdateAthleteInput}
Response
{
"data": {
"updateAthlete": {
"athlete": Athlete,
"clientMutationId": "abc123"
}
}
}
updateContest
Response
Returns an UpdateContestPayload
Arguments
| Name | Description |
|---|---|
input - UpdateContestInput!
|
Parameters for UpdateContest |
Example
Query
mutation updateContest($input: UpdateContestInput!) {
updateContest(input: $input) {
clientMutationId
contest {
...ContestFragment
}
eventDivision {
...EventDivisionFragment
}
}
}
Variables
{"input": UpdateContestInput}
Response
{
"data": {
"updateContest": {
"clientMutationId": "abc123",
"contest": Contest,
"eventDivision": EventDivision
}
}
}
updateEventConfig
Response
Returns an UpdateEventConfigPayload
Arguments
| Name | Description |
|---|---|
input - UpdateEventConfigInput!
|
Parameters for UpdateEventConfig |
Example
Query
mutation updateEventConfig($input: UpdateEventConfigInput!) {
updateEventConfig(input: $input) {
clientMutationId
event {
...EventFragment
}
}
}
Variables
{"input": UpdateEventConfigInput}
Response
{
"data": {
"updateEventConfig": {
"clientMutationId": "abc123",
"event": Event
}
}
}
updateEventDivision
Response
Returns an UpdateEventDivisionPayload
Arguments
| Name | Description |
|---|---|
input - UpdateEventDivisionInput!
|
Parameters for UpdateEventDivision |
Example
Query
mutation updateEventDivision($input: UpdateEventDivisionInput!) {
updateEventDivision(input: $input) {
clientMutationId
eventDivision {
...EventDivisionFragment
}
}
}
Variables
{"input": UpdateEventDivisionInput}
Response
{
"data": {
"updateEventDivision": {
"clientMutationId": "xyz789",
"eventDivision": EventDivision
}
}
}
updateInjury
Description
update an injury for an athlete
Response
Returns an UpdateInjuryPayload
Arguments
| Name | Description |
|---|---|
input - UpdateInjuryInput!
|
Parameters for UpdateInjury |
Example
Query
mutation updateInjury($input: UpdateInjuryInput!) {
updateInjury(input: $input) {
clientMutationId
injury {
...InjuryFragment
}
}
}
Variables
{"input": UpdateInjuryInput}
Response
{
"data": {
"updateInjury": {
"clientMutationId": "abc123",
"injury": Injury
}
}
}
updateMembership
Description
updates a membership.
Response
Returns an UpdateMembershipPayload
Arguments
| Name | Description |
|---|---|
input - UpdateMembershipInput!
|
Parameters for UpdateMembership |
Example
Query
mutation updateMembership($input: UpdateMembershipInput!) {
updateMembership(input: $input) {
clientMutationId
membership {
...MembershipFragment
}
}
}
Variables
{"input": UpdateMembershipInput}
Response
{
"data": {
"updateMembership": {
"clientMutationId": "xyz789",
"membership": Membership
}
}
}
updateOrganisation
Response
Returns an UpdateOrganisationPayload
Arguments
| Name | Description |
|---|---|
input - UpdateOrganisationInput!
|
Parameters for UpdateOrganisation |
Example
Query
mutation updateOrganisation($input: UpdateOrganisationInput!) {
updateOrganisation(input: $input) {
clientMutationId
organisation {
...OrganisationFragment
}
}
}
Variables
{"input": UpdateOrganisationInput}
Response
{
"data": {
"updateOrganisation": {
"clientMutationId": "xyz789",
"organisation": Organisation
}
}
}
updateRankingRuleOverride
Description
updates a ranking rule override for an athlete.
Response
Returns an UpdateRankingRuleOverridePayload
Arguments
| Name | Description |
|---|---|
input - UpdateRankingRuleOverrideInput!
|
Parameters for UpdateRankingRuleOverride |
Example
Query
mutation updateRankingRuleOverride($input: UpdateRankingRuleOverrideInput!) {
updateRankingRuleOverride(input: $input) {
clientMutationId
rankingRuleOverride {
...RankingRuleOverrideFragment
}
}
}
Variables
{"input": UpdateRankingRuleOverrideInput}
Response
{
"data": {
"updateRankingRuleOverride": {
"clientMutationId": "xyz789",
"rankingRuleOverride": RankingRuleOverride
}
}
}
updateRound
Response
Returns an UpdateRoundPayload
Arguments
| Name | Description |
|---|---|
input - UpdateRoundInput!
|
Parameters for UpdateRound |
Example
Query
mutation updateRound($input: UpdateRoundInput!) {
updateRound(input: $input) {
clientMutationId
heats {
...HeatFragment
}
}
}
Variables
{"input": UpdateRoundInput}
Response
{
"data": {
"updateRound": {
"clientMutationId": "xyz789",
"heats": [Heat]
}
}
}
updateSeriesGroup
Response
Returns an UpdateSeriesGroupPayload
Arguments
| Name | Description |
|---|---|
input - UpdateSeriesGroupInput!
|
Parameters for UpdateSeriesGroup |
Example
Query
mutation updateSeriesGroup($input: UpdateSeriesGroupInput!) {
updateSeriesGroup(input: $input) {
clientMutationId
seriesGroup {
...SeriesGroupFragment
}
}
}
Variables
{"input": UpdateSeriesGroupInput}
Response
{
"data": {
"updateSeriesGroup": {
"clientMutationId": "xyz789",
"seriesGroup": SeriesGroup
}
}
}
updateSponsor
Response
Returns an UpdateSponsorPayload
Arguments
| Name | Description |
|---|---|
input - UpdateSponsorInput!
|
Parameters for UpdateSponsor |
Example
Query
mutation updateSponsor($input: UpdateSponsorInput!) {
updateSponsor(input: $input) {
clientMutationId
sponsor {
...SponsorFragment
}
}
}
Variables
{"input": UpdateSponsorInput}
Response
{
"data": {
"updateSponsor": {
"clientMutationId": "xyz789",
"sponsor": Sponsor
}
}
}
updateTeamMembers
Description
Adds or removes team members from a team. The caller must be the owner of the team and the team member
Response
Returns an UpdateTeamMembersPayload
Arguments
| Name | Description |
|---|---|
input - UpdateTeamMembersInput!
|
Parameters for UpdateTeamMembers |
Example
Query
mutation updateTeamMembers($input: UpdateTeamMembersInput!) {
updateTeamMembers(input: $input) {
athleteHeats {
...CompetitorFragment
}
clientMutationId
entry {
...EntryFragment
}
}
}
Variables
{"input": UpdateTeamMembersInput}
Response
{
"data": {
"updateTeamMembers": {
"athleteHeats": [Competitor],
"clientMutationId": "abc123",
"entry": Entry
}
}
}
Types
AccountAddOnsPurchase
Fields
| Field Name | Description |
|---|---|
customTemplates - ISO8601DateTime
|
|
documentSigning - ISO8601DateTime
|
|
embed - ISO8601DateTime
|
|
whatsAppSupport - ISO8601DateTime
|
Example
{
"customTemplates": ISO8601DateTime,
"documentSigning": ISO8601DateTime,
"embed": ISO8601DateTime,
"whatsAppSupport": ISO8601DateTime
}
ActivePurchases
Fields
| Field Name | Description |
|---|---|
accountAddOns - AccountAddOnsPurchase
|
|
eventAddOns - EventAddOnsPurchase
|
|
eventCredits - EventCreditsPurchase
|
Example
{
"accountAddOns": AccountAddOnsPurchase,
"eventAddOns": EventAddOnsPurchase,
"eventCredits": EventCreditsPurchase
}
Ad
Example
{
"bgColor": "xyz789",
"callToAction": "xyz789",
"callToActionColor": "abc123",
"copy": "abc123",
"id": "4",
"logo": "abc123",
"tag": "abc123",
"url": "xyz789"
}
AddAthleteToHeatInput
Description
Autogenerated input type of AddAthleteToHeat
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
heatId - ID!
|
|
eventDivisionId - ID
|
|
athleteHeat - AthleteHeatInput!
|
Example
{
"clientMutationId": "abc123",
"heatId": "4",
"eventDivisionId": 4,
"athleteHeat": AthleteHeatInput
}
AddAthleteToHeatPayload
AddHeatToRoundInput
AddHeatToRoundPayload
AddOnBaselinePrice
AddPermissionToRecordInput
Description
Autogenerated input type of AddPermissionToRecord
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
permission - PermissionInput!
|
|
organisationId - ID!
|
Example
{
"clientMutationId": "xyz789",
"permission": PermissionInput,
"organisationId": "4"
}
AddPermissionToRecordPayload
AddPriorityInput
AddPriorityPayload
AddRankingRuleOverrideInput
Description
Autogenerated input type of AddRankingRuleOverride
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
rankingRuleOverride - RankingRuleOverrideInput!
|
Example
{
"clientMutationId": "xyz789",
"rankingRuleOverride": RankingRuleOverrideInput
}
AddRankingRuleOverridePayload
Description
Autogenerated return type of AddRankingRuleOverride.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
rankingRuleOverride - RankingRuleOverride!
|
Example
{
"clientMutationId": "xyz789",
"rankingRuleOverride": RankingRuleOverride
}
AddRoundInput
AddRoundPayload
Description
Autogenerated return type of AddRound.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
eventDivision - EventDivision!
|
Example
{
"clientMutationId": "abc123",
"eventDivision": EventDivision
}
AddSponsorInput
Description
Autogenerated input type of AddSponsor
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
sponsor - SponsorInput!
|
Example
{
"clientMutationId": "xyz789",
"sponsor": SponsorInput
}
AddSponsorPayload
AddUserToAthleteInput
Description
Autogenerated input type of AddUserToAthlete
Example
{
"clientMutationId": "abc123",
"athleteId": 4,
"name": "abc123",
"email": "abc123",
"phone": "abc123"
}
AddUserToAthletePayload
AddUserToOrganisationInput
Description
Autogenerated input type of AddUserToOrganisation
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
userDetails - OrganisationUserInput!
|
Example
{
"clientMutationId": "xyz789",
"userDetails": OrganisationUserInput
}
AddUserToOrganisationPayload
AppendChildContestInput
AppendChildContestPayload
Description
Autogenerated return type of AppendChildContest.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
eventDivision - EventDivision!
|
Example
{
"clientMutationId": "xyz789",
"eventDivision": EventDivision
}
ArchiveOrganisationPropertyInput
ArchiveOrganisationPropertyPayload
Athlete
Fields
| Field Name | Description |
|---|---|
appearances - [Competitor!]
|
|
createdAt - ISO8601Date!
|
|
dob - ISO8601Date
|
|
entries - [AthleteEntry!]
|
|
entriesWithPendingPayments - [Entry!]!
|
|
eventDivisions - [EventDivision!]!
|
|
Arguments
|
|
id - ID!
|
|
image - String
|
Image URL with an implicit max-width. Accepts any number > 0 for size in pixels or "original" for the original image |
Arguments
|
|
injuries - [Injury!]
|
|
injuryStatus - String
|
|
memberships - [AthleteMembership!]!
|
|
name - String!
|
|
nationality - String
|
|
nfcTags - [PhysicalTag!]!
|
|
properties - JSON
|
|
ranks - [EventDivisionRank!]
|
|
unfinishedEvents - [Event!]!
|
|
updatedAt - ISO8601Date!
|
|
users - [User!]!
|
|
Example
{
"appearances": [Competitor],
"createdAt": ISO8601Date,
"dob": ISO8601Date,
"entries": [AthleteEntry],
"entriesWithPendingPayments": [Entry],
"eventDivisions": [EventDivision],
"id": 4,
"image": "abc123",
"injuries": [Injury],
"injuryStatus": "xyz789",
"memberships": [AthleteMembership],
"name": "xyz789",
"nationality": "abc123",
"nfcTags": [PhysicalTag],
"properties": {},
"ranks": [EventDivisionRank],
"unfinishedEvents": [Event],
"updatedAt": ISO8601Date,
"users": [User]
}
AthleteEntry
Fields
| Field Name | Description |
|---|---|
athlete - Athlete!
|
|
athleteId - ID!
|
|
bib - String
|
|
eventDivision - EventDivision!
|
|
eventDivisionId - ID!
|
|
id - ID!
|
|
rank - Int
|
|
seed - Int
|
|
status - EntryStatusEnum!
|
|
teamMembers - [TeamMember!]
|
|
teamName - String
|
Example
{
"athlete": Athlete,
"athleteId": "4",
"bib": "abc123",
"eventDivision": EventDivision,
"eventDivisionId": 4,
"id": "4",
"rank": 123,
"seed": 987,
"status": "confirmed",
"teamMembers": [TeamMember],
"teamName": "abc123"
}
AthleteHeatInput
AthleteInput
Description
Arguments for querying or updating an athlete
Example
{
"id": 4,
"name": "xyz789",
"dob": "xyz789",
"image": "xyz789",
"userIds": [4],
"properties": {},
"registrationProperties": {},
"team": TeamInput
}
AthleteMembership
Fields
| Field Name | Description |
|---|---|
athlete - Athlete!
|
|
createdAt - ISO8601DateTime!
|
|
divisions - [Division!]
|
|
expired - Boolean!
|
|
expiryDate - ISO8601Date
|
|
id - ID!
|
|
organisation - Organisation
|
|
payments - [Payment!]
|
|
properties - JSON
|
|
series - Series
|
Example
{
"athlete": Athlete,
"createdAt": ISO8601DateTime,
"divisions": [Division],
"expired": true,
"expiryDate": ISO8601Date,
"id": 4,
"organisation": Organisation,
"payments": [Payment],
"properties": {},
"series": Series
}
AthleteRankingResult
Example
{
"athlete": Athlete,
"displayProperty": "xyz789",
"eligibleResults": 123,
"eventsToCount": ["4"],
"points": 123,
"results": [Result],
"resultsToCount": 123
}
Award
Boolean
Description
Represents true or false values.
Example
true
Break
Fields
| Field Name | Description |
|---|---|
date - ISO8601DateTime!
|
|
position - Int!
|
Example
{"date": ISO8601DateTime, "position": 987}
CancelEntryInput
CancelEntryPayload
Competitor
Fields
| Field Name | Description |
|---|---|
athlete - Athlete!
|
|
athleteId - ID!
|
|
bib - String
|
|
heat - Heat!
|
|
heatId - ID!
|
|
id - ID!
|
|
position - Int!
|
|
priority - Int
|
|
prioritySuspended - Boolean!
|
|
result - HeatResult
|
|
roundResult - HeatResult
|
|
teamMembers - [TeamMember!]
|
|
teamName - String
|
Example
{
"athlete": Athlete,
"athleteId": 4,
"bib": "abc123",
"heat": Heat,
"heatId": "4",
"id": 4,
"position": 123,
"priority": 123,
"prioritySuspended": true,
"result": HeatResult,
"roundResult": HeatResult,
"teamMembers": [TeamMember],
"teamName": "xyz789"
}
CompetitorResult
Types
| Union Types |
|---|
Example
Competitor
ConfirmEntriesInput
ConfirmEntriesPayload
Description
Autogenerated return type of ConfirmEntries.
Example
{
"clientMutationId": "xyz789",
"entries": [Entry],
"rejectedEntries": [Entry]
}
Contest
Fields
| Field Name | Description |
|---|---|
config - ContestConfig!
|
|
id - ID!
|
|
name - String
|
|
parent - Contest
|
|
result - [ContestResult!]!
|
|
savedConfig - ContestConfig!
|
|
type - String!
|
Example
{
"config": ContestConfig,
"id": 4,
"name": "xyz789",
"parent": Contest,
"result": [PointsPerPlaceResult],
"savedConfig": ContestConfig,
"type": "xyz789"
}
ContestConfig
Fields
| Field Name | Description |
|---|---|
produces - ContestConfig
|
|
result - ContestResultConfig
|
|
shape - ContestShapeConfig
|
Example
{
"produces": ContestConfig,
"result": ContestResultConfig,
"shape": ContestShapeConfig
}
ContestConfigInput
Fields
| Input Field | Description |
|---|---|
shape - ContestShapeConfigInput
|
|
result - ContestResultConfigInput
|
|
produces - ContestConfigInput
|
Example
{
"shape": ContestShapeConfigInput,
"result": ContestResultConfigInput,
"produces": ContestConfigInput
}
ContestInput
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
name - String
|
|
config - ContestConfigInput!
|
Example
{
"id": "4",
"name": "abc123",
"config": ContestConfigInput
}
ContestProgressionConfig
ContestProgressionConfigInput
ContestResult
Types
| Union Types |
|---|
Example
PointsPerPlaceResult
ContestResultConfig
Fields
| Field Name | Description |
|---|---|
config - ContestResultConfigConfig
|
|
type - String!
|
Example
{
"config": ContestResultConfigConfig,
"type": "abc123"
}
ContestResultConfigConfig
Fields
| Field Name | Description |
|---|---|
pointsPerPlace - [Int!]
|
Example
{"pointsPerPlace": [987]}
ContestResultConfigConfigInput
Fields
| Input Field | Description |
|---|---|
pointsPerPlace - [Int!]
|
Example
{"pointsPerPlace": [123]}
ContestResultConfigInput
Fields
| Input Field | Description |
|---|---|
type - String
|
|
config - ContestResultConfigConfigInput
|
Example
{
"type": "abc123",
"config": ContestResultConfigConfigInput
}
ContestShapeConfig
Fields
| Field Name | Description |
|---|---|
contestantsPerChild - Int
|
|
heatDurationMinutes - Int
|
|
numberOfChildren - Int
|
|
progression - [ContestProgressionConfig!]
|
Example
{
"contestantsPerChild": 123,
"heatDurationMinutes": 987,
"numberOfChildren": 123,
"progression": [ContestProgressionConfig]
}
ContestShapeConfigInput
Fields
| Input Field | Description |
|---|---|
numberOfChildren - Int
|
|
heatDurationMinutes - Int
|
|
contestantsPerChild - Int
|
|
progression - [ContestProgressionConfigInput!]
|
Example
{
"numberOfChildren": 123,
"heatDurationMinutes": 987,
"contestantsPerChild": 987,
"progression": [ContestProgressionConfigInput]
}
CopyEventInput
Description
Autogenerated input type of CopyEvent
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
event - EventInput!
|
|
eventId - ID!
|
Example
{
"clientMutationId": "xyz789",
"event": EventInput,
"eventId": "4"
}
CopyEventPayload
CreateEntriesInput
Description
Autogenerated input type of CreateEntries
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
eventId - ID!
|
|
entries - [EntryInput!]!
|
Example
{
"clientMutationId": "xyz789",
"eventId": 4,
"entries": [EntryInput]
}
CreateEntriesPayload
CreateEventInput
Description
Autogenerated input type of CreateEvent
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
event - EventInput!
|
Example
{
"clientMutationId": "xyz789",
"event": EventInput
}
CreateEventPayload
CreateMembershipInput
Description
Autogenerated input type of CreateMembership
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
membership - MembershipInput!
|
Example
{
"clientMutationId": "abc123",
"membership": MembershipInput
}
CreateMembershipPayload
Description
Autogenerated return type of CreateMembership.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
membership - Membership
|
Example
{
"clientMutationId": "xyz789",
"membership": Membership
}
CreateOrganisationInput
Description
Autogenerated input type of CreateOrganisation
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
organisation - OrganisationInput!
|
Example
{
"clientMutationId": "xyz789",
"organisation": OrganisationInput
}
CreateOrganisationPayload
Description
Autogenerated return type of CreateOrganisation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
organisation - Organisation!
|
Example
{
"clientMutationId": "abc123",
"organisation": Organisation
}
CreateOrganisationPropertyInput
Description
Autogenerated input type of CreateOrganisationProperty
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
id - ID!
|
|
property - PropertyInput!
|
Example
{
"clientMutationId": "xyz789",
"id": "4",
"property": PropertyInput
}
CreateOrganisationPropertyPayload
CreateSeriesGroupInput
Description
Autogenerated input type of CreateSeriesGroup
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
seriesGroup - SeriesGroupInput!
|
Example
{
"clientMutationId": "abc123",
"seriesGroup": SeriesGroupInput
}
CreateSeriesGroupPayload
Description
Autogenerated return type of CreateSeriesGroup.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
seriesGroup - SeriesGroup
|
Example
{
"clientMutationId": "xyz789",
"seriesGroup": SeriesGroup
}
CreditBaselinePrice
CustomField
Fields
| Field Name | Description |
|---|---|
config - PropertyConfig
|
|
id - ID!
|
|
label - String!
|
|
level - PropertyLevelEnum!
|
|
organisationId - ID
|
|
required - Boolean
|
|
sportType - String
|
|
type - PropertyTypeEnum!
|
|
validationType - String!
|
Example
{
"config": PropertyConfig,
"id": "4",
"label": "abc123",
"level": "user",
"organisationId": 4,
"required": true,
"sportType": "abc123",
"type": "text",
"validationType": "xyz789"
}
CustomFieldsRegistration
Fields
| Field Name | Description |
|---|---|
customField - CustomField!
|
|
id - ID!
|
|
restrictions - [Restriction!]!
|
|
uuid - ID!
|
Example
{
"customField": CustomField,
"id": 4,
"restrictions": [Restriction],
"uuid": 4
}
CustomFieldsRegistrationInput
Description
Arguments for capture fields
Fields
| Input Field | Description |
|---|---|
uuid - ID!
|
|
required - Boolean
|
|
config - PropertyConfigInput
|
Example
{
"uuid": 4,
"required": false,
"config": PropertyConfigInput
}
CutLine
DeleteContestInput
DeleteContestPayload
Description
Autogenerated return type of DeleteContest.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
eventDivision - EventDivision!
|
Example
{
"clientMutationId": "abc123",
"eventDivision": EventDivision
}
DeleteHeatInput
DeleteHeatPayload
Description
Autogenerated return type of DeleteHeat.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
eventDivision - EventDivision!
|
|
heat - Heat!
|
Example
{
"clientMutationId": "xyz789",
"eventDivision": EventDivision,
"heat": Heat
}
DeleteInjuryInput
DeleteInjuryPayload
DeleteMembershipInput
DeleteMembershipPayload
Description
Autogenerated return type of DeleteMembership.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
membership - Membership!
|
Example
{
"clientMutationId": "abc123",
"membership": Membership
}
DeleteRankingRuleOverrideInput
DeleteRankingRuleOverridePayload
Description
Autogenerated return type of DeleteRankingRuleOverride.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
rankingRuleOverride - RankingRuleOverride!
|
Example
{
"clientMutationId": "xyz789",
"rankingRuleOverride": RankingRuleOverride
}
DeleteSeriesInput
DeleteSeriesPayload
Division
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
restrictions - [DivisionRestriction!]
|
Example
{
"id": 4,
"name": "xyz789",
"restrictions": [DivisionRestriction]
}
DivisionInput
Description
Arguments for creating or updating a division
Example
{
"id": 4,
"uuid": "xyz789",
"name": "xyz789",
"organisationId": 4
}
DivisionRestriction
Fields
| Field Name | Description |
|---|---|
type - String!
|
|
value - StringOrInteger!
|
Example
{
"type": "xyz789",
"value": StringOrInteger
}
DivisionToSeasons
Fields
| Field Name | Description |
|---|---|
divisionId - ID!
|
|
id - ID!
|
|
pointAllocation - PointAllocation
|
|
pointAllocationId - ID
|
|
seasonId - ID!
|
Example
{
"divisionId": 4,
"id": "4",
"pointAllocation": PointAllocation,
"pointAllocationId": 4,
"seasonId": 4
}
EditOrganisationInput
Description
Arguments for updating an organisation
Example
{
"id": 4,
"name": "xyz789",
"sportType": "surf",
"shortName": "xyz789",
"contactEmail": "abc123",
"docusealApiKey": "abc123",
"docusealAdminEmail": "abc123",
"facebook": "abc123",
"instagram": "xyz789",
"logo": "xyz789"
}
EditSponsorInput
Description
arguments for editing a sponsor.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
|
organisationId - ID!
|
|
config - SponsorConfigInput!
|
Example
{
"id": 4,
"organisationId": 4,
"config": SponsorConfigInput
}
Fields
| Field Name | Description |
|---|---|
body - String
|
|
createdAt - ISO8601DateTime!
|
|
eventId - ID!
|
|
subject - String
|
Example
{
"body": "abc123",
"createdAt": ISO8601DateTime,
"eventId": "4",
"subject": "xyz789"
}
Entry
Fields
| Field Name | Description |
|---|---|
athlete - Athlete!
|
|
athleteId - ID!
|
|
bib - String
|
|
createdAt - ISO8601DateTime!
|
|
eventDivision - EventDivision!
|
|
eventDivisionId - ID!
|
|
id - ID!
|
|
payment - Payment
|
|
rank - Int
|
|
seed - Int
|
|
status - EntryStatusEnum!
|
|
teamMembers - [TeamMember!]
|
|
teamName - String
|
Example
{
"athlete": Athlete,
"athleteId": 4,
"bib": "abc123",
"createdAt": ISO8601DateTime,
"eventDivision": EventDivision,
"eventDivisionId": "4",
"id": "4",
"payment": Payment,
"rank": 123,
"seed": 123,
"status": "confirmed",
"teamMembers": [TeamMember],
"teamName": "xyz789"
}
EntryAthleteInput
Description
Arguments for creating or using an existing athlete when creating an entry or when adding an athlete to a team entry in a teams contest
Fields
| Input Field | Description |
|---|---|
id - ID
|
|
name - String!
|
|
dob - ISO8601DateTime
|
|
properties - JSON
|
Example
{
"id": "4",
"name": "abc123",
"dob": ISO8601DateTime,
"properties": {}
}
EntryInput
Description
Arguments for creating an entry in a specific event division. If the athleteId is specified, it will create the entry for the specific athlete. When the athleteId is not specified, it will try to use an existing federation athlete with the same name supplied inside the athlete input, and if none find will create a new athlete
Fields
| Input Field | Description |
|---|---|
eventDivisionId - ID!
|
|
athleteId - ID
|
|
athlete - EntryAthleteInput!
|
|
teamMembers - [EntryTeamMemberInput!]
|
|
teamName - String
|
|
bib - String
|
|
seed - Int
|
If the seed is not provided, the system will use the current rankings seed, if any |
properties - JSON
|
Example
{
"eventDivisionId": 4,
"athleteId": "4",
"athlete": EntryAthleteInput,
"teamMembers": [EntryTeamMemberInput],
"teamName": "abc123",
"bib": "xyz789",
"seed": 123,
"properties": {}
}
EntryLimit
EntryLimitInput
EntryStatusEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"confirmed"
EntryTeamMemberInput
Description
Arguments for creating team members for a team competing in a relays or teams type contest.
Fields
| Input Field | Description |
|---|---|
order - Int!
|
|
athleteId - ID
|
|
teamRoleId - ID
|
|
athlete - EntryAthleteInput!
|
Example
{
"order": 987,
"athleteId": 4,
"teamRoleId": 4,
"athlete": EntryAthleteInput
}
Event
Fields
| Field Name | Description |
|---|---|
activeEntriesUsers - [User!]!
|
|
captureFields - [Property!]!
|
|
competingTeams - [Team!]!
|
|
config - EventConfig
|
|
currentHeats - [Heat]!
|
|
currentScheduleIndex - Int!
|
|
date - ISO8601DateTime!
|
|
daysWindow - Int!
|
|
entries - [Entry!]
|
|
eventDivisions - [EventDivision!]!
|
|
fullSchedule - Schedule!
|
|
hideEntries - Boolean!
|
|
hideFinals - Boolean
|
|
hideNamesFromJudges - Boolean
|
|
hideScheduledTime - Boolean!
|
|
id - ID!
|
|
location - Location
|
|
media - [Media!]!
|
|
name - String!
|
|
organisation - Organisation!
|
|
organisationId - ID!
|
|
paymentOptions - PaymentOptions
|
|
priorityEnabled - Boolean
|
|
registrationOptions - RegistrationOptions
|
|
restrictions - [Restriction!]!
|
|
scheduledEntryClose - ISO8601DateTime
|
|
scheduledEntryOpen - ISO8601DateTime
|
|
seedFromSeriesId - ID
|
|
sentEmails - [Email!]
|
|
series - [Series!]!
|
|
sponsoredContentEnabled - Boolean!
|
|
sponsoredContents - [SponsoredContent!]
|
|
sponsors - [Sponsor!]!
|
|
status - EventStatus!
|
|
streams - [Stream!]!
|
|
teamLeaderboard - EventTeamLeaderboard
|
|
teams - [Team!]!
|
|
templateId - ID
|
Example
{
"activeEntriesUsers": [User],
"captureFields": [Property],
"competingTeams": [Team],
"config": EventConfig,
"currentHeats": [Heat],
"currentScheduleIndex": 987,
"date": ISO8601DateTime,
"daysWindow": 123,
"entries": [Entry],
"eventDivisions": [EventDivision],
"fullSchedule": Schedule,
"hideEntries": true,
"hideFinals": true,
"hideNamesFromJudges": true,
"hideScheduledTime": true,
"id": "4",
"location": Location,
"media": [Media],
"name": "abc123",
"organisation": Organisation,
"organisationId": "4",
"paymentOptions": PaymentOptions,
"priorityEnabled": false,
"registrationOptions": RegistrationOptions,
"restrictions": [Restriction],
"scheduledEntryClose": ISO8601DateTime,
"scheduledEntryOpen": ISO8601DateTime,
"seedFromSeriesId": "4",
"sentEmails": [Email],
"series": [Series],
"sponsoredContentEnabled": false,
"sponsoredContents": [SponsoredContent],
"sponsors": [Sponsor],
"status": "scheduled",
"streams": [Stream],
"teamLeaderboard": EventTeamLeaderboard,
"teams": [Team],
"templateId": 4
}
EventAddOnsPurchase
EventConfig
Fields
| Field Name | Description |
|---|---|
disableSchedule - Boolean
|
|
teamLeaderboard - EventTeamLeaderboardConfig
|
Example
{
"disableSchedule": true,
"teamLeaderboard": EventTeamLeaderboardConfig
}
EventConfigInput
Fields
| Input Field | Description |
|---|---|
teamLeaderboard - EventTeamLeaderboardConfigInput
|
Example
{"teamLeaderboard": EventTeamLeaderboardConfigInput}
EventCreditsPurchase
EventDivision
Fields
| Field Name | Description |
|---|---|
contestId - ID
|
|
defaultEventDurationMinutes - Int!
|
|
division - Division!
|
|
divisionToSeasons - [DivisionToSeasons!]
|
|
entries - [Entry!]!
|
|
entryCount - Int!
|
|
entryLimit - EntryLimit
|
|
event - Event!
|
|
eventDivision - EventDivision
|
|
eventDivisionId - ID
|
|
eventDivisionPointAllocations - [EventDivisionPointAllocations!]
|
|
eventDivisions - [EventDivision!]!
|
|
formatDefinition - FormatDefinition
|
|
heatConfig - HeatConfig
|
|
heatDurationMinutes - Int
|
|
heats - [Heat!]!
|
|
id - ID!
|
|
leaderboards - [Leaderboard!]
|
|
Arguments
|
|
leaderboardsWithPending - [Leaderboard!]
|
|
Arguments
|
|
order - Int
|
|
previewDraw - PreviewDraw!
|
|
Arguments
|
|
properties - JSON
|
|
ranking - [EventDivisionRank!]
|
|
Arguments
|
|
seededRounds - [SeededRound!]
|
|
sponsoredContents - [SponsoredContent!]
|
|
status - EventDivisionStatus!
|
|
teamLeaderboard - EventDivisionTeamLeaderboard
|
|
template - Template!
|
|
Example
{
"contestId": "4",
"defaultEventDurationMinutes": 123,
"division": Division,
"divisionToSeasons": [DivisionToSeasons],
"entries": [Entry],
"entryCount": 987,
"entryLimit": EntryLimit,
"event": Event,
"eventDivision": EventDivision,
"eventDivisionId": 4,
"eventDivisionPointAllocations": [
EventDivisionPointAllocations
],
"eventDivisions": [EventDivision],
"formatDefinition": FormatDefinition,
"heatConfig": HeatConfig,
"heatDurationMinutes": 123,
"heats": [Heat],
"id": "4",
"leaderboards": [Leaderboard],
"leaderboardsWithPending": [Leaderboard],
"order": 987,
"previewDraw": PreviewDraw,
"properties": {},
"ranking": [EventDivisionRank],
"seededRounds": [SeededRound],
"sponsoredContents": [SponsoredContent],
"status": "registration_open",
"teamLeaderboard": EventDivisionTeamLeaderboard,
"template": Template
}
EventDivisionInput
Description
Arguments for creating or updating an event division
Fields
| Input Field | Description |
|---|---|
id - ID
|
|
templateId - ID
|
Set the competition template to use in this event division. If this value is not set, the event division will be created with the organisation's default template. |
order - Int
|
Set the order so that event divisions are listed in order within the event |
divisionId - ID
|
Pass a divisionId when using an existing division |
division - DivisionInput
|
Pass a division object when creating a new division |
entryLimit - EntryLimitInput
|
Pass an entryLimit object when limiting the available spots in a division |
Example
{
"id": "4",
"templateId": "4",
"order": 123,
"divisionId": 4,
"division": DivisionInput,
"entryLimit": EntryLimitInput
}
EventDivisionPointAllocations
Fields
| Field Name | Description |
|---|---|
eventDivisionId - ID!
|
|
id - ID!
|
|
pointAllocation - PointAllocation
|
|
pointAllocationId - ID
|
|
seasonId - ID!
|
Example
{
"eventDivisionId": 4,
"id": "4",
"pointAllocation": PointAllocation,
"pointAllocationId": "4",
"seasonId": "4"
}
EventDivisionRank
Example
{
"athleteId": "4",
"competitor": Competitor,
"eventDivisionId": "4",
"excluded": false,
"id": 4,
"place": 123,
"rides": {},
"total": 123.45
}
EventDivisionStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"registration_open"
EventDivisionTeamLeaderboard
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
result - [EventDivisionTeamLeaderboardResult!]!
|
Example
{"id": 4, "result": [EventDivisionTeamLeaderboardResult]}
EventDivisionTeamLeaderboardResult
Fields
| Field Name | Description |
|---|---|
memberResults - [HeatResult!]!
|
|
place - Int
|
|
teamName - String!
|
|
total - Float
|
Example
{
"memberResults": [HeatResult],
"place": 987,
"teamName": "xyz789",
"total": 123.45
}
EventInput
Description
Arguments for creating or updating an event
Fields
| Input Field | Description |
|---|---|
id - ID
|
|
status - EventStatus
|
|
name - String!
|
|
organisationId - ID!
|
|
date - ISO8601DateTime!
|
|
daysWindow - Int!
|
|
seriesIds - [ID!]
|
|
seedFromSeriesId - ID
|
|
eventDivisions - [EventDivisionInput!]!
|
|
customFieldsRegistrationsAttributes - [CustomFieldsRegistrationInput!]
|
|
location - LocationInput
|
Example
{
"id": "4",
"status": "scheduled",
"name": "abc123",
"organisationId": 4,
"date": ISO8601DateTime,
"daysWindow": 123,
"seriesIds": ["4"],
"seedFromSeriesId": 4,
"eventDivisions": [EventDivisionInput],
"customFieldsRegistrationsAttributes": [
CustomFieldsRegistrationInput
],
"location": LocationInput
}
EventLocationInput
Description
Arguments for querying an event by location
Fields
| Input Field | Description |
|---|---|
country - String
|
The country to search by |
coordinates - LocationCoordinatesInput
|
Coordinates to search within a radius |
Example
{
"country": "abc123",
"coordinates": LocationCoordinatesInput
}
EventStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"scheduled"
EventTeamLeaderboard
Fields
| Field Name | Description |
|---|---|
config - EventTeamLeaderboardConfig
|
|
id - ID!
|
|
result - [EventTeamLeaderboardResult!]!
|
Example
{
"config": EventTeamLeaderboardConfig,
"id": 4,
"result": [EventTeamLeaderboardResult]
}
EventTeamLeaderboardConfig
Fields
| Field Name | Description |
|---|---|
pointsPerPlace - [Int]
|
Example
{"pointsPerPlace": [987]}
EventTeamLeaderboardConfigInput
Fields
| Input Field | Description |
|---|---|
pointsPerPlace - [Int!]!
|
Example
{"pointsPerPlace": [123]}
EventTeamLeaderboardResult
ExcludeAthleteFromRankingsInput
Description
Autogenerated input type of ExcludeAthleteFromRankings
Example
{
"clientMutationId": "abc123",
"eventDivisionId": "4",
"childEventDivisionId": "4",
"athleteId": "4",
"exclude": true
}
ExcludeAthleteFromRankingsPayload
Description
Autogenerated return type of ExcludeAthleteFromRankings.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
eventDivision - EventDivision!
|
Example
{
"clientMutationId": "abc123",
"eventDivision": EventDivision
}
Extras
FederationRootEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"root"
FederationTeams
Float
Description
Represents signed double-precision fractional values as specified by IEEE 754.
Example
123.45
FormatDefinition
Fields
| Field Name | Description |
|---|---|
defaultHeatDurationMinutes - Int
|
|
entriesRandomized - Boolean
|
|
hasBibs - Boolean
|
|
hasStartlist - Boolean
|
|
heatSizes - JSON
|
|
hideSeeds - Boolean
|
|
isTeams - Boolean
|
|
manualProgression - JSON
|
|
numberOfRounds - Int
|
|
progression - JSON
|
|
roundBased - Boolean
|
|
runBased - Boolean
|
|
runProgression - JSON
|
|
seeds - JSON
|
|
teamConfig - TeamConfig
|
|
teamLeaderboard - Boolean!
|
Example
{
"defaultHeatDurationMinutes": 123,
"entriesRandomized": false,
"hasBibs": true,
"hasStartlist": false,
"heatSizes": {},
"hideSeeds": true,
"isTeams": false,
"manualProgression": {},
"numberOfRounds": 987,
"progression": {},
"roundBased": false,
"runBased": false,
"runProgression": {},
"seeds": {},
"teamConfig": TeamConfig,
"teamLeaderboard": true
}
FormatDefinitionInput
Description
Arguments for updating format definition
Fields
| Input Field | Description |
|---|---|
numberOfRounds - Int
|
|
roundBased - Boolean
|
|
runBased - Boolean
|
|
teamLeaderboard - Boolean
|
|
isTeams - Boolean
|
|
teamConfig - TeamConfigInput
|
|
seeds - JSON
|
|
manualProgression - JSON
|
|
heatSizes - JSON
|
|
progression - JSON
|
|
runProgression - JSON
|
|
defaultHeatDurationMinutes - Int
|
|
hideSeeds - Boolean
|
|
hasBibs - Boolean
|
|
entriesRandomized - Boolean
|
Example
{
"numberOfRounds": 123,
"roundBased": false,
"runBased": false,
"teamLeaderboard": true,
"isTeams": false,
"teamConfig": TeamConfigInput,
"seeds": {},
"manualProgression": {},
"heatSizes": {},
"progression": {},
"runProgression": {},
"defaultHeatDurationMinutes": 987,
"hideSeeds": false,
"hasBibs": true,
"entriesRandomized": true
}
Heat
Fields
| Field Name | Description |
|---|---|
competitors - [Competitor!]!
|
|
config - HeatConfig!
|
|
contestId - ID
|
|
endTime - ISO8601DateTime
|
|
eventDivision - EventDivision!
|
|
eventDivisionId - ID!
|
|
group - HeatGroup
|
|
heatDurationMinutes - Int
|
|
id - ID!
|
|
media - [Media!]!
|
|
podium - String
|
|
position - Int!
|
|
progressions - [HeatProgression]
|
|
remainingMillisecondsOnPause - Int
|
|
result - [HeatResult!]!
|
|
resultWithPending - [HeatResult!]!
|
|
resumeTime - ISO8601DateTime
|
|
round - String!
|
|
roundPosition - Int!
|
|
scheduledTime - ISO8601DateTime
|
|
Arguments
|
|
startTime - ISO8601DateTime
|
|
Example
{
"competitors": [Competitor],
"config": HeatConfig,
"contestId": "4",
"endTime": ISO8601DateTime,
"eventDivision": EventDivision,
"eventDivisionId": 4,
"group": HeatGroup,
"heatDurationMinutes": 123,
"id": 4,
"media": [Media],
"podium": "abc123",
"position": 123,
"progressions": [HeatProgression],
"remainingMillisecondsOnPause": 987,
"result": [HeatResult],
"resultWithPending": [HeatResult],
"resumeTime": ISO8601DateTime,
"round": "xyz789",
"roundPosition": 123,
"scheduledTime": ISO8601DateTime,
"startTime": ISO8601DateTime
}
HeatConfig
Fields
| Field Name | Description |
|---|---|
athleteRidesLimit - Int
|
|
calculator - String
|
|
categories - JSON
|
|
categoryGroups - JSON
|
|
hasLeaderboard - Boolean
|
|
hasPriority - Boolean
|
|
hasStartlist - Boolean
|
|
heatSize - Int!
|
|
hideNamesFromJudges - Boolean
|
|
hideNeeds - Boolean
|
|
hideScheduledTime - Boolean
|
|
hideScores - Boolean
|
|
hideTimer - Boolean
|
|
inputFormat - String
|
|
isTeams - Boolean
|
|
jerseyOrder - [String!]
|
|
maxRideScore - Int!
|
|
modifiers - [String!]!
|
|
numberOfLanes - Int
|
|
requiresApproval - Boolean
|
|
runBased - Boolean
|
|
teamConfig - TeamConfig
|
|
totalCountingRides - Int
|
|
usesLanes - Boolean
|
Example
{
"athleteRidesLimit": 987,
"calculator": "xyz789",
"categories": {},
"categoryGroups": {},
"hasLeaderboard": false,
"hasPriority": true,
"hasStartlist": false,
"heatSize": 123,
"hideNamesFromJudges": false,
"hideNeeds": false,
"hideScheduledTime": false,
"hideScores": false,
"hideTimer": true,
"inputFormat": "xyz789",
"isTeams": true,
"jerseyOrder": ["abc123"],
"maxRideScore": 123,
"modifiers": ["xyz789"],
"numberOfLanes": 987,
"requiresApproval": false,
"runBased": false,
"teamConfig": TeamConfig,
"totalCountingRides": 123,
"usesLanes": false
}
HeatGroup
HeatProgression
HeatResult
Example
{
"athleteId": 4,
"competitor": Competitor,
"countingMember": true,
"needs": 123.45,
"place": 987,
"rides": {},
"total": 987.65,
"winBy": 123.45
}
HierarchyLevelEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"self_and_ancestors"
ID
Description
Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.
Example
4
ISO8601Date
Description
An ISO 8601-encoded date
Example
ISO8601Date
ISO8601DateTime
Description
An ISO 8601-encoded datetime
Example
ISO8601DateTime
Injury
Fields
| Field Name | Description |
|---|---|
athlete - Athlete!
|
|
id - ID!
|
|
injuryDate - ISO8601Date!
|
|
notes - String
|
|
recoveryDate - ISO8601Date
|
Example
{
"athlete": Athlete,
"id": "4",
"injuryDate": ISO8601Date,
"notes": "xyz789",
"recoveryDate": ISO8601Date
}
InjuryInput
Description
arguments for creating an injury.
Fields
| Input Field | Description |
|---|---|
id - ID
|
|
notes - String!
|
|
injuryDate - ISO8601Date!
|
|
recoveryDate - ISO8601Date
|
|
athleteId - ID!
|
Example
{
"id": 4,
"notes": "abc123",
"injuryDate": ISO8601Date,
"recoveryDate": ISO8601Date,
"athleteId": "4"
}
InjuryUpdateInput
Description
arguments for updating an injury.
Fields
| Input Field | Description |
|---|---|
id - ID
|
|
notes - String!
|
|
injuryDate - ISO8601Date!
|
|
recoveryDate - ISO8601Date
|
Example
{
"id": "4",
"notes": "xyz789",
"injuryDate": ISO8601Date,
"recoveryDate": ISO8601Date
}
Int
Description
Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
987
JSON
Description
Represents untyped JSON
Example
{}
Leaderboard
Fields
| Field Name | Description |
|---|---|
competitors - [Competitor!]!
|
|
config - HeatConfig!
|
|
endTime - ISO8601DateTime
|
|
eventDivision - EventDivision!
|
|
heatDurationMinutes - Int
|
|
heats - [Heat!]!
|
|
id - ID!
|
|
result - [HeatResult!]!
|
|
round - String!
|
|
roundPosition - Int!
|
|
startTime - ISO8601DateTime
|
Example
{
"competitors": [Competitor],
"config": HeatConfig,
"endTime": ISO8601DateTime,
"eventDivision": EventDivision,
"heatDurationMinutes": 987,
"heats": [Heat],
"id": "4",
"result": [HeatResult],
"round": "abc123",
"roundPosition": 123,
"startTime": ISO8601DateTime
}
LinkTagToAthleteInput
Description
Autogenerated input type of LinkTagToAthlete
Example
{
"clientMutationId": "xyz789",
"serialNumber": "4",
"humanReadableId": "4",
"athleteId": "4"
}
LinkTagToAthletePayload
Description
Autogenerated return type of LinkTagToAthlete.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
tag - PhysicalTag
|
Example
{
"clientMutationId": "xyz789",
"tag": PhysicalTag
}
Location
Example
{
"addressType": "xyz789",
"country": "xyz789",
"countryCode": "xyz789",
"formattedAddress": "xyz789",
"googleMapsUri": "xyz789",
"id": "4",
"location": LocationCoordinates,
"placePredictionText": "abc123",
"timezone": Timezone
}
LocationCoordinates
LocationCoordinatesInput
LocationInput
Description
Arguments for event location
Fields
| Input Field | Description |
|---|---|
id - ID!
|
ID of location |
formattedAddress - String!
|
A full human-readable address for this place |
googleMapsUri - String!
|
Google Maps URI for this location |
location - LocationCoordinatesInput!
|
Coordinates for this location |
placePredictionText - String!
|
A human-readable name for this place |
country - String
|
The country of this location |
countryCode - String
|
The 2 letter country code of this location |
timezone - TimezoneInput
|
timezone details for this location on a specific date |
addressType - String
|
Type of address (e.g. 'country') |
Example
{
"id": "4",
"formattedAddress": "abc123",
"googleMapsUri": "abc123",
"location": LocationCoordinatesInput,
"placePredictionText": "abc123",
"country": "xyz789",
"countryCode": "abc123",
"timezone": TimezoneInput,
"addressType": "abc123"
}
LogInjuryInput
Description
Autogenerated input type of LogInjury
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
injury - InjuryInput!
|
Example
{
"clientMutationId": "xyz789",
"injury": InjuryInput
}
LogInjuryPayload
MarketFactor
Media
MediaTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
Example
"image"
MemberAthleteInput
Description
arguments for creating or updating a member athlete.
Fields
| Input Field | Description |
|---|---|
id - ID
|
|
name - String!
|
|
dob - String
|
|
user - UserInput!
|
Example
{
"id": "4",
"name": "xyz789",
"dob": "xyz789",
"user": UserInput
}
Membership
Fields
| Field Name | Description |
|---|---|
athlete - Athlete!
|
|
athleteId - ID!
|
|
createdAt - ISO8601DateTime!
|
|
divisions - [Division!]
|
|
expired - Boolean!
|
|
expiredByUsage - MembershipStatus!
|
|
expiryDate - ISO8601Date
|
|
id - ID!
|
|
organisation - Organisation
|
|
payments - [Payment!]
|
|
properties - JSON
|
|
series - Series
|
Example
{
"athlete": Athlete,
"athleteId": "4",
"createdAt": ISO8601DateTime,
"divisions": [Division],
"expired": false,
"expiredByUsage": MembershipStatus,
"expiryDate": ISO8601Date,
"id": "4",
"organisation": Organisation,
"payments": [Payment],
"properties": {},
"series": Series
}
MembershipInput
Description
arguments for creating a membership.
Example
{
"id": "4",
"organisationId": 4,
"seriesId": "4",
"divisionIds": [4],
"expiryDate": "abc123",
"properties": {},
"athlete": MemberAthleteInput
}
MembershipStatus
Fields
| Field Name | Description |
|---|---|
expired - String!
|
|
seriesEntries - [SeriesEntries!]!
|
Example
{
"expired": "xyz789",
"seriesEntries": [SeriesEntries]
}
MembershipUpdateInput
Description
arguments for updating a membership.
Example
{
"id": "4",
"organisationId": "4",
"seriesId": "4",
"divisionIds": ["4"],
"expiryDate": "xyz789",
"properties": {}
}
Memberships
Fields
| Field Name | Description |
|---|---|
memberships - [Membership!]!
|
|
totalCount - Int!
|
Example
{"memberships": [Membership], "totalCount": 123}
MergeAthletesInput
MergeAthletesPayload
MoveHeatItemInput
Description
Arguments for moving heat items
Fields
| Input Field | Description |
|---|---|
type - MoveHeatItemTypeEnum!
|
|
heatId - ID!
|
|
position - Int!
|
|
removedItems - [Int!]
|
|
data - MoveHeatItemProgressionInput
|
Example
{
"type": "competitor",
"heatId": "4",
"position": 123,
"removedItems": [987],
"data": MoveHeatItemProgressionInput
}
MoveHeatItemProgressionInput
MoveHeatItemTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"competitor"
MoveHeatItemsInput
Description
Autogenerated input type of MoveHeatItems
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
eventDivisionId - ID!
|
|
source - MoveHeatItemInput!
|
|
target - MoveHeatItemInput!
|
Example
{
"clientMutationId": "abc123",
"eventDivisionId": "4",
"source": MoveHeatItemInput,
"target": MoveHeatItemInput
}
MoveHeatItemsPayload
Options
Fields
| Field Name | Description |
|---|---|
currency - String
|
|
defaultDivisionPrice - Int
|
|
divisions - [PaymentOptionsDivisions!]
|
|
extraDivisionPrice - Int
|
|
extras - [PaymentExtra!]
|
|
familyTotal - JSON
|
|
federatedMembership - Boolean
|
|
managedByParent - Boolean
|
|
rollingMembership - RollingMembership
|
Example
{
"currency": "abc123",
"defaultDivisionPrice": 123,
"divisions": [PaymentOptionsDivisions],
"extraDivisionPrice": 123,
"extras": [PaymentExtra],
"familyTotal": {},
"federatedMembership": true,
"managedByParent": true,
"rollingMembership": RollingMembership
}
Organisation
Fields
| Field Name | Description |
|---|---|
activePurchases - ActivePurchases
|
|
contactEmail - String!
|
|
customProperties - [Property!]
|
|
Arguments
|
|
divisions - [Division!]!
|
|
docusealEnabled - Boolean!
|
|
eventTemplates - [Event!]!
|
|
events - [Event!]!
|
|
facebook - String
|
|
federatedOrganisationTerm - String
|
|
federatedOrganisations - [Organisation!]
|
|
federationPointAllocations - [PointAllocation!]!
|
|
federationProperties - [Property!]!
|
|
Arguments
|
|
federationSeries - [Series!]!
|
|
Arguments
|
|
federationTeams - [Team!]!
|
|
Arguments
|
|
federationTemplates - [Template!]!
|
|
id - ID!
|
|
instagram - String
|
|
latestPayment - Payment
|
|
logo - String
|
Image URL with an implicit max-width. Accepts any number > 0 for size in pixels or "original" for the original image |
Arguments
|
|
manageInjuriesEnabled - Boolean!
|
|
name - String!
|
|
payables - [Payable!]
|
|
paymentsEnabled - Boolean!
|
|
paymentsReceived - Payments
|
|
series - [Series!]!
|
|
seriesGroups - [SeriesGroup!]!
|
|
shortName - String!
|
|
sponsors - [Sponsor!]!
|
|
sportType - String!
|
|
stripeAccountDetails - StripeAccountDetails!
|
|
teamManagersEnabled - Boolean!
|
|
transactionFee - Float!
|
|
useNfc - Boolean
|
|
Example
{
"activePurchases": ActivePurchases,
"contactEmail": "xyz789",
"customProperties": [Property],
"divisions": [Division],
"docusealEnabled": true,
"eventTemplates": [Event],
"events": [Event],
"facebook": "abc123",
"federatedOrganisationTerm": "xyz789",
"federatedOrganisations": [Organisation],
"federationPointAllocations": [PointAllocation],
"federationProperties": [Property],
"federationSeries": [Series],
"federationTeams": [Team],
"federationTemplates": [Template],
"id": 4,
"instagram": "abc123",
"latestPayment": Payment,
"logo": "abc123",
"manageInjuriesEnabled": false,
"name": "xyz789",
"payables": [Event],
"paymentsEnabled": true,
"paymentsReceived": Payments,
"series": [Series],
"seriesGroups": [SeriesGroup],
"shortName": "abc123",
"sponsors": [Sponsor],
"sportType": "abc123",
"stripeAccountDetails": StripeAccountDetails,
"teamManagersEnabled": true,
"transactionFee": 987.65,
"useNfc": false
}
OrganisationAthletes
Fields
| Field Name | Description |
|---|---|
athletes - [Athlete!]!
|
|
totalCount - Int!
|
Example
{"athletes": [Athlete], "totalCount": 123}
OrganisationInput
Description
Arguments for creating or updating an organisation
Example
{
"id": 4,
"name": "abc123",
"sportType": "surf",
"shortName": "abc123",
"contactEmail": "abc123",
"facebook": "xyz789",
"instagram": "xyz789",
"logo": "xyz789"
}
OrganisationUserInput
Owner
Types
| Union Types |
|---|
Example
User
Parameter
Payable
Payment
Fields
| Field Name | Description |
|---|---|
amount - Int!
|
|
chargeId - String
|
|
createdAt - ISO8601DateTime!
|
|
currency - String!
|
|
directCharge - Boolean!
|
|
entries - [Entry!]!
|
|
fee - Int!
|
|
id - ID!
|
|
intentId - String
|
|
payable - Payable!
|
|
purchasedOptions - PurchasedOptions
|
|
refunds - [Refund!]
|
|
registrationError - String
|
|
status - String!
|
|
user - User!
|
Example
{
"amount": 123,
"chargeId": "abc123",
"createdAt": ISO8601DateTime,
"currency": "abc123",
"directCharge": true,
"entries": [Entry],
"fee": 123,
"id": 4,
"intentId": "xyz789",
"payable": Event,
"purchasedOptions": PurchasedOptions,
"refunds": [Refund],
"registrationError": "abc123",
"status": "abc123",
"user": User
}
PaymentExtra
PaymentOptions
Fields
| Field Name | Description |
|---|---|
currency - String
|
|
defaultDivisionPrice - Int
|
|
divisions - [PaymentOptionsDivisions!]
|
|
extraDivisionPrice - Int
|
|
extras - [PaymentExtra!]
|
|
familyTotal - JSON
|
Example
{
"currency": "xyz789",
"defaultDivisionPrice": 987,
"divisions": [PaymentOptionsDivisions],
"extraDivisionPrice": 123,
"extras": [PaymentExtra],
"familyTotal": {}
}
PaymentOptionsDivisions
Payments
Fields
| Field Name | Description |
|---|---|
payments - [Payment!]!
|
|
totalCount - Int!
|
Example
{"payments": [Payment], "totalCount": 123}
Permission
PermissionInput
Description
Records for creating a permission
Fields
| Input Field | Description |
|---|---|
owner - UserInput!
|
|
record - RecordInput!
|
|
scopes - String!
|
Example
{
"owner": UserInput,
"record": RecordInput,
"scopes": "xyz789"
}
PhysicalTag
Podium
PointAllocation
PointsPerPlaceResult
Fields
| Field Name | Description |
|---|---|
competitor - Competitor!
|
|
place - Int!
|
|
placeCounts - [Int]!
|
|
total - Float!
|
Example
{
"competitor": Competitor,
"place": 987,
"placeCounts": [123],
"total": 123.45
}
PreviewDraw
Fields
| Field Name | Description |
|---|---|
rounds - [PreviewRound!]!
|
Example
{"rounds": [PreviewRound]}
PreviewHeat
PreviewRound
Fields
| Field Name | Description |
|---|---|
heats - [PreviewHeat!]!
|
|
name - String!
|
|
roundPosition - Int!
|
Example
{
"heats": [PreviewHeat],
"name": "xyz789",
"roundPosition": 123
}
PricingData
Fields
| Field Name | Description |
|---|---|
addOnBaselinePrices - [AddOnBaselinePrice!]!
|
|
country - String
|
|
creditBaselinePrices - [CreditBaselinePrice!]!
|
|
currency - String!
|
|
marketFactors - [MarketFactor!]!
|
|
region - String!
|
|
sizeFactors - [SizeFactor!]!
|
|
volumeDiscounts - [Float!]!
|
Example
{
"addOnBaselinePrices": [AddOnBaselinePrice],
"country": "abc123",
"creditBaselinePrices": [CreditBaselinePrice],
"currency": "abc123",
"marketFactors": [MarketFactor],
"region": "xyz789",
"sizeFactors": [SizeFactor],
"volumeDiscounts": [987.65]
}
Property
Fields
| Field Name | Description |
|---|---|
config - PropertyConfig
|
|
disabled - Boolean
|
|
docusealTemplateId - ID
|
|
docusealTemplateSlug - String
|
|
id - ID!
|
|
label - String!
|
|
level - PropertyLevelEnum!
|
|
organisationId - ID
|
|
required - Boolean
|
|
sportType - String
|
|
type - PropertyTypeEnum!
|
|
uuid - ID!
|
|
validationType - String!
|
|
value - String
|
Example
{
"config": PropertyConfig,
"disabled": false,
"docusealTemplateId": 4,
"docusealTemplateSlug": "abc123",
"id": "4",
"label": "abc123",
"level": "user",
"organisationId": 4,
"required": true,
"sportType": "xyz789",
"type": "text",
"uuid": "4",
"validationType": "xyz789",
"value": "xyz789"
}
PropertyConfig
Example
{
"description": "xyz789",
"docusealTemplateId": "4",
"docusealTemplateSlug": "xyz789",
"options": ["xyz789"],
"requireIf": RequireIf,
"restricted": false,
"validation": Validation
}
PropertyConfigInput
PropertyInput
Description
Arguments for creating or updating an organisation custom property
Fields
| Input Field | Description |
|---|---|
uuid - ID
|
|
label - String!
|
|
type - PropertyTypeEnum!
|
|
level - PropertyLevelEnum!
|
|
required - Boolean
|
|
options - [String!]
|
|
deleted - Boolean
|
|
config - PropertyConfigInput
|
Example
{
"uuid": 4,
"label": "abc123",
"type": "text",
"level": "user",
"required": false,
"options": ["xyz789"],
"deleted": true,
"config": PropertyConfigInput
}
PropertyLevelEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"user"
PropertyTypeEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"text"
PurchasedOptions
Fields
| Field Name | Description |
|---|---|
athletes - [RegisteringAthlete!]!
|
Example
{"athletes": [RegisteringAthlete]}
RankingFilters
Fields
| Field Name | Description |
|---|---|
property - RankingPropertyFilter
|
Example
{"property": RankingPropertyFilter}
RankingOptions
Fields
| Field Name | Description |
|---|---|
countingResultsOverrides - Boolean
|
|
cutLines - [CutLine!]
|
|
eligibleResults - JSON
|
|
filters - RankingFilters
|
Example
{
"countingResultsOverrides": false,
"cutLines": [CutLine],
"eligibleResults": {},
"filters": RankingFilters
}
RankingPropertyFilter
RankingRuleOverride
RankingRuleOverrideInput
Record
Types
| Union Types |
|---|
Example
Team
RecordInput
Refund
RefundPaymentInput
RefundPaymentPayload
RegisteringAthlete
Fields
| Field Name | Description |
|---|---|
extras - [Extras!]
|
|
name - String!
|
|
registrationsAttributes - [RegistrationsAttribute!]
|
Example
{
"extras": [Extras],
"name": "abc123",
"registrationsAttributes": [RegistrationsAttribute]
}
RegistrationOptions
Fields
| Field Name | Description |
|---|---|
captureProperties - [Property!]
|
|
divisionLimit - Int
|
|
divisions - [RegistrationOptionsDivisions!]
|
|
mode - String
|
|
notes - String
|
|
teamRequired - Boolean
|
|
teamsMode - String
|
|
termsAndConditionsLink - String
|
|
termsOwner - String
|
|
waitlisted - Boolean
|
Example
{
"captureProperties": [Property],
"divisionLimit": 987,
"divisions": [RegistrationOptionsDivisions],
"mode": "abc123",
"notes": "xyz789",
"teamRequired": true,
"teamsMode": "abc123",
"termsAndConditionsLink": "abc123",
"termsOwner": "abc123",
"waitlisted": false
}
RegistrationOptionsDivisions
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
maxAge - Int
|
|
maxBy - ISO8601Date
|
|
minAge - Int
|
|
minBy - ISO8601Date
|
Example
{
"id": 4,
"maxAge": 987,
"maxBy": ISO8601Date,
"minAge": 123,
"minBy": ISO8601Date
}
RegistrationsAttribute
RemoveAthleteFromHeatInput
RemoveAthleteFromHeatPayload
RemovePermissionFromRecordInput
RemovePermissionFromRecordPayload
RemovePriorityInput
RemovePriorityPayload
RemoveUserFromOrganisationInput
RemoveUserFromOrganisationPayload
RequireIf
Fields
| Field Name | Description |
|---|---|
conditions - [RequireIfCondition!]!
|
|
operator - RequireIfOperator
|
Example
{"conditions": [RequireIfCondition], "operator": "and"}
RequireIfComparator
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"greater"
RequireIfCondition
Fields
| Field Name | Description |
|---|---|
comparator - RequireIfComparator!
|
|
property - String!
|
|
value - String!
|
Example
{
"comparator": "greater",
"property": "abc123",
"value": "xyz789"
}
RequireIfOperator
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"and"
ResetUserPasswordInput
Description
Autogenerated input type of ResetUserPassword
Example
{
"clientMutationId": "xyz789",
"id": 4,
"password": "abc123",
"confirmPassword": "xyz789"
}
ResetUserPasswordPayload
Restrictable
Types
| Union Types |
|---|
Example
Event
Restriction
Fields
| Field Name | Description |
|---|---|
config - RestrictionConfig
|
|
customField - CustomField
|
|
customFieldId - ID
|
|
customFieldsRegistration - CustomFieldsRegistration
|
|
id - ID!
|
|
restrictable - Restrictable!
|
|
restrictableId - String!
|
|
restrictableType - String!
|
|
type - String!
|
Example
{
"config": RestrictionConfig,
"customField": CustomField,
"customFieldId": 4,
"customFieldsRegistration": CustomFieldsRegistration,
"id": "4",
"restrictable": Event,
"restrictableId": "xyz789",
"restrictableType": "xyz789",
"type": "xyz789"
}
RestrictionAgeConfig
RestrictionConfig
Fields
| Field Name | Description |
|---|---|
ages - [RestrictionAgeConfig!]
|
|
awards - [Award!]
|
|
byDate - String
|
|
checkPatrolHours - Boolean
|
|
maxAge - Int
|
|
minAge - Int
|
|
minimumOptions - [RestrictionMinimumOptionsConfig!]
|
|
operator - String
|
|
options - [String!]
|
Example
{
"ages": [RestrictionAgeConfig],
"awards": [Award],
"byDate": "xyz789",
"checkPatrolHours": false,
"maxAge": 123,
"minAge": 123,
"minimumOptions": [RestrictionMinimumOptionsConfig],
"operator": "xyz789",
"options": ["abc123"]
}
RestrictionMinimumOptionsConfig
RestrictionValidationResult
Example
{
"message": "abc123",
"restrictableId": "xyz789",
"restrictableType": "abc123",
"restrictionConfig": RestrictionConfig,
"restrictionId": "4",
"restrictionType": "xyz789",
"valid": false
}
Result
RollingMembership
Fields
| Field Name | Description |
|---|---|
currency - String
|
|
defaultDivisionPrice - Int
|
|
divisions - [PaymentOptionsDivisions!]
|
|
extraDivisionPrice - Int
|
|
extras - [PaymentExtra!]
|
|
familyTotal - JSON
|
|
length - Int!
|
|
unit - String!
|
Example
{
"currency": "abc123",
"defaultDivisionPrice": 987,
"divisions": [PaymentOptionsDivisions],
"extraDivisionPrice": 123,
"extras": [PaymentExtra],
"familyTotal": {},
"length": 123,
"unit": "abc123"
}
SaveEventDivisionAsTemplateInput
Description
Autogenerated input type of SaveEventDivisionAsTemplate
Example
{
"clientMutationId": "abc123",
"name": "abc123",
"eventDivisionId": "4",
"organisationId": "4"
}
SaveEventDivisionAsTemplatePayload
Description
Autogenerated return type of SaveEventDivisionAsTemplate.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
eventDivision - EventDivision
|
Example
{
"clientMutationId": "abc123",
"eventDivision": EventDivision
}
Schedule
SeededRound
SendEventEmailInput
Description
Autogenerated input type of SendEventEmail
Example
{
"clientMutationId": "abc123",
"eventId": "4",
"subject": "abc123",
"message": "xyz789"
}
SendEventEmailPayload
Series
Fields
| Field Name | Description |
|---|---|
allDivisions - [Division!]!
|
Deprecated in favor of fetching rankingsDivision directly, this causes lots of db queries and lookups |
allMembershipsByEvents - [Membership!]
|
|
Arguments
|
|
athleteRankingResults - AthleteRankingResult
|
|
availableRankingFilters - [String!]
|
|
Arguments
|
|
captureFields - [Property!]!
|
|
childSeries - [Series!]!
|
|
divisions - [Division!]!
|
Deprecated in favor of fetching specific membershipDivisions or rankingsDivision |
events - [Event!]
|
|
exclusive - Boolean!
|
|
id - ID!
|
|
membershipDivisions - [Division!]!
|
|
name - String!
|
|
options - Options
|
|
organisation - Organisation!
|
|
organisationId - ID!
|
|
paginatedMemberships - Memberships
|
|
parentSeries - Series
|
|
pointAllocationId - ID
|
|
rankingOptions - RankingOptions
|
|
rankings - [SeriesRank!]
|
|
rankingsDisplayProperty - JSON
|
|
rankingsDivisions - [Division!]!
|
|
registrationOptions - RegistrationOptions
|
|
results - [Result!]
|
Deprecated in favor of athleteRankingResults which contains more information |
resultsToCount - JSON
|
|
seriesGroupId - ID
|
|
signOnStatus - SignOnStatus!
|
|
Example
{
"allDivisions": [Division],
"allMembershipsByEvents": [Membership],
"athleteRankingResults": AthleteRankingResult,
"availableRankingFilters": ["xyz789"],
"captureFields": [Property],
"childSeries": [Series],
"divisions": [Division],
"events": [Event],
"exclusive": true,
"id": "4",
"membershipDivisions": [Division],
"name": "xyz789",
"options": Options,
"organisation": Organisation,
"organisationId": "4",
"paginatedMemberships": Memberships,
"parentSeries": Series,
"pointAllocationId": "4",
"rankingOptions": RankingOptions,
"rankings": [SeriesRank],
"rankingsDisplayProperty": {},
"rankingsDivisions": [Division],
"registrationOptions": RegistrationOptions,
"results": [Result],
"resultsToCount": {},
"seriesGroupId": "4",
"signOnStatus": "closed"
}
SeriesEntries
SeriesGroup
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
organisation - Organisation!
|
|
organisationId - ID!
|
|
series - [Series!]!
|
Example
{
"id": 4,
"name": "abc123",
"organisation": Organisation,
"organisationId": 4,
"series": [Series]
}
SeriesGroupInput
SeriesRank
Fields
| Field Name | Description |
|---|---|
athlete - Athlete!
|
|
displayProperty - String
|
|
place - Int!
|
|
points - Int!
|
|
results - [Result!]!
|
Example
{
"athlete": Athlete,
"displayProperty": "abc123",
"place": 123,
"points": 123,
"results": [Result]
}
SignOnStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"closed"
SizeFactor
Sponsor
Fields
| Field Name | Description |
|---|---|
config - SponsorConfig!
|
|
id - ID!
|
|
organisation - Organisation!
|
Example
{
"config": SponsorConfig,
"id": 4,
"organisation": Organisation
}
SponsorConfig
SponsorConfigInput
SponsorInput
Description
arguments for creating a sponsor.
Fields
| Input Field | Description |
|---|---|
config - SponsorConfigInput!
|
|
organisationId - ID!
|
Example
{
"config": SponsorConfigInput,
"organisationId": "4"
}
SponsoredContent
SportType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"surf"
Stream
Fields
| Field Name | Description |
|---|---|
endDate - ISO8601DateTime
|
|
id - ID!
|
|
metadata - StreamMetadata
|
|
name - String
|
|
protocol - StreamProtocol
|
|
service - String
|
|
startDate - ISO8601DateTime
|
|
url - String!
|
Example
{
"endDate": ISO8601DateTime,
"id": "4",
"metadata": StreamMetadata,
"name": "abc123",
"protocol": "hls",
"service": "abc123",
"startDate": ISO8601DateTime,
"url": "xyz789"
}
StreamMetadata
StreamProtocol
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"hls"
String
Description
Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.
Example
"xyz789"
StringOrInteger
Description
An integer or a string
Example
StringOrInteger
StripeAccountDetails
SuspendPriorityInput
SuspendPriorityPayload
Team
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
permissions - [Permission!]!
|
Example
{
"id": "4",
"name": "abc123",
"permissions": [Permission]
}
TeamConfig
TeamConfigInput
Description
Arguments for updating team config
Fields
| Input Field | Description |
|---|---|
athletesPerTeam - Int
|
Example
{"athletesPerTeam": 123}
TeamInput
TeamMember
TeamMemberInput
Description
Arguments for adding a team member, creating the athlete when necessary
Example
{
"id": "4",
"order": 987,
"athleteId": 4,
"athlete": AthleteInput,
"teamRoleId": "4",
"teamRoleName": "xyz789",
"_destroy": false
}
TeamRole
Template
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
organisationId - ID
|
|
sportType - String
|
|
teamRoles - [TeamRole!]!
|
Example
{
"id": 4,
"name": "xyz789",
"organisationId": "4",
"sportType": "abc123",
"teamRoles": [TeamRole]
}
Timezone
Fields
| Field Name | Description |
|---|---|
date - ISO8601Date!
|
|
name - String!
|
|
utcOffsetMinutes - Int!
|
Example
{
"date": ISO8601Date,
"name": "abc123",
"utcOffsetMinutes": 123
}
TimezoneInput
Description
arguments for timezone
Fields
| Input Field | Description |
|---|---|
name - String!
|
timezone name |
utcOffsetMinutes - Int!
|
utc offset in minutes as of date |
date - ISO8601Date!
|
date of timezone |
Example
{
"name": "xyz789",
"utcOffsetMinutes": 987,
"date": ISO8601Date
}
UngroupSeriesGroupInput
UngroupSeriesGroupPayload
Description
Autogenerated return type of UngroupSeriesGroup.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
organisation - Organisation!
|
Example
{
"clientMutationId": "xyz789",
"organisation": Organisation
}
UnsuspendPriorityInput
UnsuspendPriorityPayload
UpdateAthleteInput
Description
Autogenerated input type of UpdateAthlete
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
id - ID!
|
|
athlete - AthleteInput!
|
Example
{
"clientMutationId": "abc123",
"id": 4,
"athlete": AthleteInput
}
UpdateAthletePayload
UpdateContestInput
Description
Autogenerated input type of UpdateContest
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
contest - ContestInput!
|
Example
{
"clientMutationId": "abc123",
"contest": ContestInput
}
UpdateContestPayload
Description
Autogenerated return type of UpdateContest.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
contest - Contest!
|
|
eventDivision - EventDivision!
|
Example
{
"clientMutationId": "xyz789",
"contest": Contest,
"eventDivision": EventDivision
}
UpdateEventConfigInput
Description
Autogenerated input type of UpdateEventConfig
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
eventId - ID!
|
|
config - EventConfigInput!
|
Example
{
"clientMutationId": "xyz789",
"eventId": 4,
"config": EventConfigInput
}
UpdateEventConfigPayload
UpdateEventDivisionInput
Description
Autogenerated input type of UpdateEventDivision
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
eventDivisionId - ID!
|
|
formatDefinition - FormatDefinitionInput
|
|
entryLimit - EntryLimitInput
|
Example
{
"clientMutationId": "abc123",
"eventDivisionId": 4,
"formatDefinition": FormatDefinitionInput,
"entryLimit": EntryLimitInput
}
UpdateEventDivisionPayload
Description
Autogenerated return type of UpdateEventDivision.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
eventDivision - EventDivision!
|
Example
{
"clientMutationId": "xyz789",
"eventDivision": EventDivision
}
UpdateInjuryInput
Description
Autogenerated input type of UpdateInjury
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
injury - InjuryUpdateInput!
|
Example
{
"clientMutationId": "abc123",
"injury": InjuryUpdateInput
}
UpdateInjuryPayload
UpdateMembershipInput
Description
Autogenerated input type of UpdateMembership
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
membership - MembershipUpdateInput!
|
Example
{
"clientMutationId": "abc123",
"membership": MembershipUpdateInput
}
UpdateMembershipPayload
Description
Autogenerated return type of UpdateMembership.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
membership - Membership
|
Example
{
"clientMutationId": "xyz789",
"membership": Membership
}
UpdateOrganisationInput
Description
Autogenerated input type of UpdateOrganisation
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
organisation - EditOrganisationInput!
|
Example
{
"clientMutationId": "xyz789",
"organisation": EditOrganisationInput
}
UpdateOrganisationPayload
Description
Autogenerated return type of UpdateOrganisation.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
organisation - Organisation!
|
Example
{
"clientMutationId": "xyz789",
"organisation": Organisation
}
UpdateRankingRuleOverrideInput
Description
Autogenerated input type of UpdateRankingRuleOverride
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
rankingRuleOverride - RankingRuleOverrideInput!
|
Example
{
"clientMutationId": "xyz789",
"rankingRuleOverride": RankingRuleOverrideInput
}
UpdateRankingRuleOverridePayload
Description
Autogenerated return type of UpdateRankingRuleOverride.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
rankingRuleOverride - RankingRuleOverride!
|
Example
{
"clientMutationId": "xyz789",
"rankingRuleOverride": RankingRuleOverride
}
UpdateRoundInput
Description
Autogenerated input type of UpdateRound
Example
{
"clientMutationId": "abc123",
"eventDivisionId": 4,
"roundPosition": 123,
"roundName": "abc123",
"heatDurationMinutes": 123
}
UpdateRoundPayload
UpdateSeriesGroupInput
Description
Autogenerated input type of UpdateSeriesGroup
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
seriesGroup - SeriesGroupInput!
|
Example
{
"clientMutationId": "abc123",
"seriesGroup": SeriesGroupInput
}
UpdateSeriesGroupPayload
Description
Autogenerated return type of UpdateSeriesGroup.
Fields
| Field Name | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
seriesGroup - SeriesGroup
|
Example
{
"clientMutationId": "abc123",
"seriesGroup": SeriesGroup
}
UpdateSponsorInput
Description
Autogenerated input type of UpdateSponsor
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
sponsor - EditSponsorInput!
|
Example
{
"clientMutationId": "xyz789",
"sponsor": EditSponsorInput
}
UpdateSponsorPayload
UpdateTeamMembersInput
Description
Autogenerated input type of UpdateTeamMembers
Fields
| Input Field | Description |
|---|---|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
entryId - ID!
|
|
teamMembers - [TeamMemberInput!]!
|
Example
{
"clientMutationId": "abc123",
"entryId": "4",
"teamMembers": [TeamMemberInput]
}
UpdateTeamMembersPayload
Description
Autogenerated return type of UpdateTeamMembers.
Fields
| Field Name | Description |
|---|---|
athleteHeats - [Competitor!]!
|
|
clientMutationId - String
|
A unique identifier for the client performing the mutation. |
entry - Entry!
|
Example
{
"athleteHeats": [Competitor],
"clientMutationId": "abc123",
"entry": Entry
}
User
Fields
| Field Name | Description |
|---|---|
athletes - [Athlete!]!
|
|
competitors - [Competitor!]!
|
|
email - String!
|
|
entries - [Entry!]!
|
|
eventAthletes - [Athlete!]!
|
|
Arguments
|
|
eventEmails - [Email!]
|
|
id - ID!
|
|
image - String
|
|
name - String
|
|
pendingPayments - [Payment!]!
|
|
phone - String
|
|
properties - JSON
|
|
role - String!
|
|
unfinishedEvents - [Event!]!
|
|
Example
{
"athletes": [Athlete],
"competitors": [Competitor],
"email": "abc123",
"entries": [Entry],
"eventAthletes": [Athlete],
"eventEmails": [Email],
"id": 4,
"image": "abc123",
"name": "abc123",
"pendingPayments": [Payment],
"phone": "abc123",
"properties": {},
"role": "abc123",
"unfinishedEvents": [Event]
}
UserInput
UserRole
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"director"
Validation
Fields
| Field Name | Description |
|---|---|
idName - String
|
|
parameters - [Parameter!]
|
|
params - [String!]
|
|
url - String
|
Example
{
"idName": "abc123",
"parameters": [Parameter],
"params": ["abc123"],
"url": "abc123"
}