Admin API Reference
The Admin API allows you to configure every aspect of your ticketing setup, and to retrieve customer and transaction data.
Separate to the Admin API, the Customer API allows your customers to purchase tickets.
Terms of Service
API Endpoints
# Admin API:
https://[your-mightytix-domain]/admin-api/graphql
Headers
# JWT authentication token
Authorization: Bearer <YOUR_AUTH_TOKEN>
Authentication
The Admin API requires a JWT authentication token.
The token can be retrieved with a POST request to the
endpoint /admin-api/auth/login by supplying the
email and password parameters:
TOKEN=$(curl \
--request POST \
--silent \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"email":"tonystark@stark.example.com","password":"ironman"}' \
https://demo.mightytix.com/admin-api/auth/login | jq -r '.accessToken')
The returned token can then be used as an authorization header for subsequent requests:
curl \
--silent \
--header "authorization: Bearer ${TOKEN}" \
--header 'Content-Type: application/json' \
--data '{"query":"query {\n ticketTypes{\n edges{\n node{\n id\n name\n}\n}}\n}\n"}' \
https://demo.mightytix.com/admin-api/graphql
The authorization token will expire after five minutes. To
refresh it, use the refresh token sent as a cookie in
response to the login endpoint:
curl \
--include \
--request POST \
--silent \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"email":"tonystark@stark.example.com","password":"ironman"}' \
https://demo.mightytix.com/admin-api/auth/login | grep ^set-cookie
set-cookie: refreshToken=eyJhbG...QFzQQ; Path=/admin-api/auth/refresh; HttpOnly; Secure
Then make a request to the endpoint
/admin-api/auth/refresh and include the same
cookie:
curl \
--cookie "refreshToken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyZWZyZXNoVG9rZW4iOiJVSFRuakVIZ3k2MExZUlFZdm9WNnVXQzJLME5jWGExTSIsInN1YiI6IjZiYWM3NjZhLWEzZGUtNDMzMi05ZWViLWZmZWMxNGEzMTczNCIsInBlcnNpc3QiOmZhbHNlLCJpYXQiOjE2NTYxNDM4MzQsImV4cCI6MTY1ODczNTgzNH0.AZBdse5n5GOOgpeBFT_YDsT8ynh341Q_HohnB1Ye9-A" \
https://demo.mightytix.com/admin-api/auth/refresh
A refresh token can be used only once. The response to the
refresh request will include a new
refreshToken cookie, which must be used for the
next refresh.
By default the refresh token cookie has no expiry, so
browsers will discard it when a session is finished. To
request a persistent cookie that will expire after one
month, provide a persist parameter of
true when logging in:
curl \
--include \
--request POST \
--silent \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"email":"tonystark@stark.example.com","password":"ironman","persist":true}' \
https://demo.mightytix.com/admin-api/auth/login | grep ^set-cookie
set-cookie: refreshToken=eyJhbG...QFzQQ; Path=/admin-api/auth/refresh; Expires=Sun, 1 Jan 2023 00:00:00 GMT; HttpOnly; Secure
Queries
account
Response
Returns an
Account!
Example
Query
query Account {
account {
billingExpiry
billingInterval
billingPriceId
billingSubscriptionId
created
currency
events {
created
descriptionHtml
id
name
sessions {
...EventSessionsConnectionFragment
}
status
updated
}
locale
name
sessions {
capacity
countIssued
countPending
created
doors
end
event {
...EventFragment
}
eventId
id
offsale
onsale
sales
sessionTicketTypes {
...SessionTicketTypeFragment
}
start
updated
venue {
...VenueFragment
}
}
ticketTypes {
bookingFee
created
id
name
price
sessionTicketTypes {
...SessionTicketTypeFragment
}
sort
updated
}
updated
url
users {
created
email
firstName
id
lastLogin
lastName
updated
}
}
}
Response
{
"data": {
"account": {
"billingExpiry": "2023-01-01T00:00:00.000Z",
"billingInterval": "abc123",
"billingPriceId": "xyz789",
"billingSubscriptionId": "xyz789",
"created": "2023-01-01T00:00:00.000Z",
"currency": "USD",
"events": [Event],
"locale": "en-US",
"name": "Stark Industries",
"sessions": [Session],
"ticketTypes": [TicketType],
"updated": "2023-01-01T00:00:00.000Z",
"url": "stark.example.com",
"users": [User]
}
}
}
billingPlans
Response
Returns
[BillingPlan!]!
Example
Query
query BillingPlans {
billingPlans {
description
id
name
terms {
currency
id
period
price
}
}
}
Response
{
"data": {
"billingPlans": [
{
"description": "abc123",
"id": "xyz789",
"name": "abc123",
"terms": [BillingPlanTerm]
}
]
}
}
event
Example
Query
query Event($id: ID!) {
event(id: $id) {
created
descriptionHtml
id
name
sessions {
edges {
...SessionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
status
updated
}
}
Variables
{"id": "4"}
Response
{
"data": {
"event": {
"created": "2023-01-01T00:00:00.000Z",
"descriptionHtml": "<p>The event description.</p>",
"id": "4",
"name": "The Event Name",
"sessions": EventSessionsConnection,
"status": 4,
"updated": "2023-01-01T00:00:00.000Z"
}
}
}
events
Response
Returns an
EventConnection!
Arguments
| Name | Description |
|---|---|
filter
-
EventFilter
|
Specify to filter the records returned. Default =
{}
|
paging
-
CursorPaging
|
Limit or page results. Default =
{first: 10}
|
sorting
-
[EventSort!]
|
Specify to sort results. Default =
[{direction: ASC, field: name}]
|
Example
Query
query Events(
$filter: EventFilter,
$paging: CursorPaging,
$sorting: [EventSort!]
) {
events(
filter: $filter,
paging: $paging,
sorting: $sorting
) {
edges {
cursor
node {
...EventFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{
"filter": {},
"paging": {"first": 10},
"sorting": [{"direction": "ASC", "field": "name"}]
}
Response
{
"data": {
"events": {
"edges": [EventEdge],
"pageInfo": PageInfo
}
}
}
onboardingProgress
Response
Returns an
OnboardingProgress!
Example
Query
query OnboardingProgress {
onboardingProgress {
event
eventId
gateway
onsale
session
ticketType
url
venue
}
}
Response
{
"data": {
"onboardingProgress": {
"event": false,
"eventId": "abc123",
"gateway": "CONNECTED",
"onsale": false,
"session": false,
"ticketType": false,
"url": false,
"venue": true
}
}
}
order
Example
Query
query Order($id: ID!) {
order(id: $id) {
acceptsMarketing
bookingFees
cardExpMonth
cardExpYear
cardLast4
cardNetwork
email
firstName
id
lastName
originalBookingFees
originalPaymentFees
originalSubtotal
originalTotal
paymentFees
paymentIntentId
paymentStatus
phone
processed
publicId
subtotal
tickets {
bookingFee
id
number
order {
...OrderFragment
}
price
sessionId
sessionTicketType {
...SessionTicketTypeFragment
}
status
}
ticketsAggregate {
count {
...OrderTicketsCountAggregateFragment
}
groupBy {
...OrderTicketsAggregateGroupByFragment
}
max {
...OrderTicketsMaxAggregateFragment
}
min {
...OrderTicketsMinAggregateFragment
}
}
total
}
}
Variables
{"id": "4"}
Response
{
"data": {
"order": {
"acceptsMarketing": true,
"bookingFees": "123.45",
"cardExpMonth": 123.45,
"cardExpYear": 987.65,
"cardLast4": 987.65,
"cardNetwork": "abc123",
"email": "xyz789",
"firstName": "xyz789",
"id": 4,
"lastName": "abc123",
"originalBookingFees": "123.45",
"originalPaymentFees": "123.45",
"originalSubtotal": "123.45",
"originalTotal": "123.45",
"paymentFees": "123.45",
"paymentIntentId": "xyz789",
"paymentStatus": "PAID",
"phone": "xyz789",
"processed": "2023-01-01T00:00:00.000Z",
"publicId": "abc123",
"subtotal": "123.45",
"tickets": [Ticket],
"ticketsAggregate": [OrderTicketsAggregateResponse],
"total": "123.45"
}
}
}
orders
Response
Returns an
OrderConnection!
Arguments
| Name | Description |
|---|---|
filter
-
OrderFilter
|
Specify to filter the records returned. Default =
{}
|
paging
-
CursorPaging
|
Limit or page results. Default =
{first: 10}
|
sorting
-
[OrderSort!]
|
Specify to sort results. Default = []
|
Example
Query
query Orders(
$filter: OrderFilter,
$paging: CursorPaging,
$sorting: [OrderSort!]
) {
orders(
filter: $filter,
paging: $paging,
sorting: $sorting
) {
edges {
cursor
node {
...OrderFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{"filter": {}, "paging": {"first": 10}, "sorting": [""]}
Response
{
"data": {
"orders": {
"edges": [OrderEdge],
"pageInfo": PageInfo
}
}
}
recentInvoices
Response
Returns
[BillingInvoice!]!
Example
Query
query RecentInvoices {
recentInvoices {
amount
date
id
status
url
}
}
Response
{
"data": {
"recentInvoices": [
{
"amount": "123.45",
"date": "2023-01-01T00:00:00.000Z",
"id": "abc123",
"status": "abc123",
"url": "xyz789"
}
]
}
}
session
Example
Query
query Session($id: ID!) {
session(id: $id) {
capacity
countIssued
countPending
created
doors
end
event {
created
descriptionHtml
id
name
sessions {
...EventSessionsConnectionFragment
}
status
updated
}
eventId
id
offsale
onsale
sales
sessionTicketTypes {
bookingFee
capacity
countIssued
countPending
enabled
price
sales
session {
...SessionFragment
}
sessionId
ticketType {
...TicketTypeFragment
}
ticketTypeId
}
start
updated
venue {
address
capacity
city
country
created
id
latLong
name
postalCode
sessions {
...SessionFragment
}
space
state
suburb
timezone
updated
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"session": {
"capacity": 123,
"countIssued": 123,
"countPending": 987,
"created": "2023-01-01T00:00:00.000Z",
"doors": "2023-01-01T00:00:00.000Z",
"end": "2023-01-01T00:00:00.000Z",
"event": Event,
"eventId": "xyz789",
"id": 4,
"offsale": "2023-01-01T00:00:00.000Z",
"onsale": "2023-01-01T00:00:00.000Z",
"sales": "123.45",
"sessionTicketTypes": [SessionTicketType],
"start": "2023-01-01T00:00:00.000Z",
"updated": "2023-01-01T00:00:00.000Z",
"venue": Venue
}
}
}
sessionTicketType
Response
Returns a
SessionTicketType
Arguments
| Name | Description |
|---|---|
id -
ID!
|
The id of the record to find. |
Example
Query
query SessionTicketType($id: ID!) {
sessionTicketType(id: $id) {
bookingFee
capacity
countIssued
countPending
enabled
price
sales
session {
capacity
countIssued
countPending
created
doors
end
event {
...EventFragment
}
eventId
id
offsale
onsale
sales
sessionTicketTypes {
...SessionTicketTypeFragment
}
start
updated
venue {
...VenueFragment
}
}
sessionId
ticketType {
bookingFee
created
id
name
price
sessionTicketTypes {
...SessionTicketTypeFragment
}
sort
updated
}
ticketTypeId
}
}
Variables
{"id": "4"}
Response
{
"data": {
"sessionTicketType": {
"bookingFee": "123.45",
"capacity": 123,
"countIssued": 123,
"countPending": 123,
"enabled": false,
"price": "123.45",
"sales": "123.45",
"session": Session,
"sessionId": "4",
"ticketType": TicketType,
"ticketTypeId": "4"
}
}
}
sessionTicketTypes
Response
Returns a
SessionTicketTypeConnection!
Arguments
| Name | Description |
|---|---|
filter
-
SessionTicketTypeFilter
|
Specify to filter the records returned. Default =
{}
|
paging
-
CursorPaging
|
Limit or page results. Default =
{first: 10}
|
sorting
-
[SessionTicketTypeSort!]
|
Specify to sort results. Default = []
|
Example
Query
query SessionTicketTypes(
$filter: SessionTicketTypeFilter,
$paging: CursorPaging,
$sorting: [SessionTicketTypeSort!]
) {
sessionTicketTypes(
filter: $filter,
paging: $paging,
sorting: $sorting
) {
edges {
cursor
node {
...SessionTicketTypeFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{"filter": {}, "paging": {"first": 10}, "sorting": [""]}
Response
{
"data": {
"sessionTicketTypes": {
"edges": [SessionTicketTypeEdge],
"pageInfo": PageInfo
}
}
}
sessions
Response
Returns a
SessionConnection!
Arguments
| Name | Description |
|---|---|
filter
-
SessionFilter
|
Specify to filter the records returned. Default =
{}
|
paging
-
CursorPaging
|
Limit or page results. Default =
{first: 10}
|
sorting
-
[SessionSort!]
|
Specify to sort results. Default =
[{direction: ASC, field: start}]
|
Example
Query
query Sessions(
$filter: SessionFilter,
$paging: CursorPaging,
$sorting: [SessionSort!]
) {
sessions(
filter: $filter,
paging: $paging,
sorting: $sorting
) {
edges {
cursor
node {
...SessionFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{
"filter": {},
"paging": {"first": 10},
"sorting": [{"direction": "ASC", "field": "start"}]
}
Response
{
"data": {
"sessions": {
"edges": [SessionEdge],
"pageInfo": PageInfo
}
}
}
stripeCurrency
Response
Returns a
GatewayCurrency!
Example
Query
query StripeCurrency {
stripeCurrency {
default
supported
}
}
Response
{
"data": {
"stripeCurrency": {
"default": "xyz789",
"supported": ["xyz789"]
}
}
}
stripeGateway
Response
Returns a
PaymentGateway
Example
Query
query StripeGateway {
stripeGateway {
created
feeFixed
feeMatch
feePercent
provider
updated
}
}
Response
{
"data": {
"stripeGateway": {
"created": "2023-01-01T00:00:00.000Z",
"feeFixed": "123.45",
"feeMatch": false,
"feePercent": 123.45,
"provider": "BRAINTREE",
"updated": "2023-01-01T00:00:00.000Z"
}
}
}
stripeGatewayStatus
Response
Returns a
PaymentGatewayStatus!
Example
Query
query StripeGatewayStatus {
stripeGatewayStatus
}
Response
{"data": {"stripeGatewayStatus": "CONNECTED"}}
ticketType
Response
Returns a
TicketType
Arguments
| Name | Description |
|---|---|
id -
ID!
|
The id of the record to find. |
Example
Query
query TicketType($id: ID!) {
ticketType(id: $id) {
bookingFee
created
id
name
price
sessionTicketTypes {
bookingFee
capacity
countIssued
countPending
enabled
price
sales
session {
...SessionFragment
}
sessionId
ticketType {
...TicketTypeFragment
}
ticketTypeId
}
sort
updated
}
}
Variables
{"id": "4"}
Response
{
"data": {
"ticketType": {
"bookingFee": "123.45",
"created": "2023-01-01T00:00:00.000Z",
"id": "4",
"name": "xyz789",
"price": "123.45",
"sessionTicketTypes": [SessionTicketType],
"sort": 987,
"updated": "2023-01-01T00:00:00.000Z"
}
}
}
ticketTypes
Response
Returns a
TicketTypeConnection!
Arguments
| Name | Description |
|---|---|
filter
-
TicketTypeFilter
|
Specify to filter the records returned. Default =
{}
|
paging
-
CursorPaging
|
Limit or page results. Default =
{first: 10}
|
sorting
-
[TicketTypeSort!]
|
Specify to sort results. Default =
[{direction: ASC, field: sort}, {direction: ASC,
field: name}]
|
Example
Query
query TicketTypes(
$filter: TicketTypeFilter,
$paging: CursorPaging,
$sorting: [TicketTypeSort!]
) {
ticketTypes(
filter: $filter,
paging: $paging,
sorting: $sorting
) {
edges {
cursor
node {
...TicketTypeFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{
"filter": {},
"paging": {"first": 10},
"sorting": [
{"direction": "ASC", "field": "sort"},
{"direction": "ASC", "field": "name"}
]
}
Response
{
"data": {
"ticketTypes": {
"edges": [TicketTypeEdge],
"pageInfo": PageInfo
}
}
}
user
Example
Query
query User($id: ID!) {
user(id: $id) {
created
email
firstName
id
lastLogin
lastName
updated
}
}
Variables
{"id": "4"}
Response
{
"data": {
"user": {
"created": "2023-01-01T00:00:00.000Z",
"email": "abc123",
"firstName": "xyz789",
"id": "4",
"lastLogin": "2023-01-01T00:00:00.000Z",
"lastName": "xyz789",
"updated": "2023-01-01T00:00:00.000Z"
}
}
}
users
Response
Returns a
UserConnection!
Arguments
| Name | Description |
|---|---|
filter
-
UserFilter
|
Specify to filter the records returned. Default =
{}
|
paging
-
CursorPaging
|
Limit or page results. Default =
{first: 10}
|
sorting
-
[UserSort!]
|
Specify to sort results. Default = []
|
Example
Query
query Users(
$filter: UserFilter,
$paging: CursorPaging,
$sorting: [UserSort!]
) {
users(
filter: $filter,
paging: $paging,
sorting: $sorting
) {
edges {
cursor
node {
...UserFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{"filter": {}, "paging": {"first": 10}, "sorting": [""]}
Response
{
"data": {
"users": {
"edges": [UserEdge],
"pageInfo": PageInfo
}
}
}
venue
Example
Query
query Venue($id: ID!) {
venue(id: $id) {
address
capacity
city
country
created
id
latLong
name
postalCode
sessions {
capacity
countIssued
countPending
created
doors
end
event {
...EventFragment
}
eventId
id
offsale
onsale
sales
sessionTicketTypes {
...SessionTicketTypeFragment
}
start
updated
venue {
...VenueFragment
}
}
space
state
suburb
timezone
updated
}
}
Variables
{"id": "4"}
Response
{
"data": {
"venue": {
"address": "abc123",
"capacity": 123,
"city": "xyz789",
"country": "xyz789",
"created": "2023-01-01T00:00:00.000Z",
"id": "4",
"latLong": "xyz789",
"name": "xyz789",
"postalCode": "xyz789",
"sessions": [Session],
"space": "abc123",
"state": "xyz789",
"suburb": "xyz789",
"timezone": "xyz789",
"updated": "2023-01-01T00:00:00.000Z"
}
}
}
venues
Response
Returns a
VenueConnection!
Arguments
| Name | Description |
|---|---|
filter
-
VenueFilter
|
Specify to filter the records returned. Default =
{}
|
paging
-
CursorPaging
|
Limit or page results. Default =
{first: 10}
|
sorting
-
[VenueSort!]
|
Specify to sort results. Default =
[{direction: ASC, field: name}, {direction: ASC,
field: space}]
|
Example
Query
query Venues(
$filter: VenueFilter,
$paging: CursorPaging,
$sorting: [VenueSort!]
) {
venues(
filter: $filter,
paging: $paging,
sorting: $sorting
) {
edges {
cursor
node {
...VenueFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{
"filter": {},
"paging": {"first": 10},
"sorting": [
{"direction": "ASC", "field": "name"},
{"direction": "ASC", "field": "space"}
]
}
Response
{
"data": {
"venues": {
"edges": [VenueEdge],
"pageInfo": PageInfo
}
}
}
Mutations
addBillingPlan
Example
Query
mutation AddBillingPlan($sessionId: String!) {
addBillingPlan(sessionId: $sessionId) {
billingExpiry
billingInterval
billingPriceId
billingSubscriptionId
created
currency
events {
created
descriptionHtml
id
name
sessions {
...EventSessionsConnectionFragment
}
status
updated
}
locale
name
sessions {
capacity
countIssued
countPending
created
doors
end
event {
...EventFragment
}
eventId
id
offsale
onsale
sales
sessionTicketTypes {
...SessionTicketTypeFragment
}
start
updated
venue {
...VenueFragment
}
}
ticketTypes {
bookingFee
created
id
name
price
sessionTicketTypes {
...SessionTicketTypeFragment
}
sort
updated
}
updated
url
users {
created
email
firstName
id
lastLogin
lastName
updated
}
}
}
Variables
{"sessionId": "abc123"}
Response
{
"data": {
"addBillingPlan": {
"billingExpiry": "2023-01-01T00:00:00.000Z",
"billingInterval": "abc123",
"billingPriceId": "abc123",
"billingSubscriptionId": "abc123",
"created": "2023-01-01T00:00:00.000Z",
"currency": "USD",
"events": [Event],
"locale": "en-US",
"name": "Stark Industries",
"sessions": [Session],
"ticketTypes": [TicketType],
"updated": "2023-01-01T00:00:00.000Z",
"url": "stark.example.com",
"users": [User]
}
}
}
addSessionTicketTypesToSession
Response
Returns a
Session!
Arguments
| Name | Description |
|---|---|
input
-
AddSessionTicketTypesToSessionInput!
|
Example
Query
mutation AddSessionTicketTypesToSession($input: AddSessionTicketTypesToSessionInput!) {
addSessionTicketTypesToSession(input: $input) {
capacity
countIssued
countPending
created
doors
end
event {
created
descriptionHtml
id
name
sessions {
...EventSessionsConnectionFragment
}
status
updated
}
eventId
id
offsale
onsale
sales
sessionTicketTypes {
bookingFee
capacity
countIssued
countPending
enabled
price
sales
session {
...SessionFragment
}
sessionId
ticketType {
...TicketTypeFragment
}
ticketTypeId
}
start
updated
venue {
address
capacity
city
country
created
id
latLong
name
postalCode
sessions {
...SessionFragment
}
space
state
suburb
timezone
updated
}
}
}
Variables
{"input": AddSessionTicketTypesToSessionInput}
Response
{
"data": {
"addSessionTicketTypesToSession": {
"capacity": 987,
"countIssued": 987,
"countPending": 123,
"created": "2023-01-01T00:00:00.000Z",
"doors": "2023-01-01T00:00:00.000Z",
"end": "2023-01-01T00:00:00.000Z",
"event": Event,
"eventId": "abc123",
"id": 4,
"offsale": "2023-01-01T00:00:00.000Z",
"onsale": "2023-01-01T00:00:00.000Z",
"sales": "123.45",
"sessionTicketTypes": [SessionTicketType],
"start": "2023-01-01T00:00:00.000Z",
"updated": "2023-01-01T00:00:00.000Z",
"venue": Venue
}
}
}
addSessionTicketTypesToTicketType
Response
Returns a
TicketType!
Arguments
| Name | Description |
|---|---|
input
-
AddSessionTicketTypesToTicketTypeInput!
|
Example
Query
mutation AddSessionTicketTypesToTicketType($input: AddSessionTicketTypesToTicketTypeInput!) {
addSessionTicketTypesToTicketType(input: $input) {
bookingFee
created
id
name
price
sessionTicketTypes {
bookingFee
capacity
countIssued
countPending
enabled
price
sales
session {
...SessionFragment
}
sessionId
ticketType {
...TicketTypeFragment
}
ticketTypeId
}
sort
updated
}
}
Variables
{"input": AddSessionTicketTypesToTicketTypeInput}
Response
{
"data": {
"addSessionTicketTypesToTicketType": {
"bookingFee": "123.45",
"created": "2023-01-01T00:00:00.000Z",
"id": 4,
"name": "xyz789",
"price": "123.45",
"sessionTicketTypes": [SessionTicketType],
"sort": 987,
"updated": "2023-01-01T00:00:00.000Z"
}
}
}
createBillingCheckoutLink
createBillingPortalLink
Response
Returns a
String!
Example
Query
mutation CreateBillingPortalLink {
createBillingPortalLink
}
Response
{
"data": {
"createBillingPortalLink": "abc123"
}
}
createManyEvents
Response
Returns
[Event!]!
Arguments
| Name | Description |
|---|---|
input
-
CreateManyEventsInput!
|
Example
Query
mutation CreateManyEvents($input: CreateManyEventsInput!) {
createManyEvents(input: $input) {
created
descriptionHtml
id
name
sessions {
edges {
...SessionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
status
updated
}
}
Variables
{"input": CreateManyEventsInput}
Response
{
"data": {
"createManyEvents": [
{
"created": "2023-01-01T00:00:00.000Z",
"descriptionHtml": "<p>The event description.</p>",
"id": "4",
"name": "The Event Name",
"sessions": EventSessionsConnection,
"status": 4,
"updated": "2023-01-01T00:00:00.000Z"
}
]
}
}
createManySessionTicketTypes
Response
Returns
[SessionTicketType!]!
Arguments
| Name | Description |
|---|---|
input
-
CreateManySessionTicketTypesInput!
|
Example
Query
mutation CreateManySessionTicketTypes($input: CreateManySessionTicketTypesInput!) {
createManySessionTicketTypes(input: $input) {
bookingFee
capacity
countIssued
countPending
enabled
price
sales
session {
capacity
countIssued
countPending
created
doors
end
event {
...EventFragment
}
eventId
id
offsale
onsale
sales
sessionTicketTypes {
...SessionTicketTypeFragment
}
start
updated
venue {
...VenueFragment
}
}
sessionId
ticketType {
bookingFee
created
id
name
price
sessionTicketTypes {
...SessionTicketTypeFragment
}
sort
updated
}
ticketTypeId
}
}
Variables
{"input": CreateManySessionTicketTypesInput}
Response
{
"data": {
"createManySessionTicketTypes": [
{
"bookingFee": "123.45",
"capacity": 123,
"countIssued": 123,
"countPending": 987,
"enabled": false,
"price": "123.45",
"sales": "123.45",
"session": Session,
"sessionId": 4,
"ticketType": TicketType,
"ticketTypeId": 4
}
]
}
}
createManySessions
Response
Returns
[Session!]!
Arguments
| Name | Description |
|---|---|
input
-
CreateManySessionsInput!
|
Example
Query
mutation CreateManySessions($input: CreateManySessionsInput!) {
createManySessions(input: $input) {
capacity
countIssued
countPending
created
doors
end
event {
created
descriptionHtml
id
name
sessions {
...EventSessionsConnectionFragment
}
status
updated
}
eventId
id
offsale
onsale
sales
sessionTicketTypes {
bookingFee
capacity
countIssued
countPending
enabled
price
sales
session {
...SessionFragment
}
sessionId
ticketType {
...TicketTypeFragment
}
ticketTypeId
}
start
updated
venue {
address
capacity
city
country
created
id
latLong
name
postalCode
sessions {
...SessionFragment
}
space
state
suburb
timezone
updated
}
}
}
Variables
{"input": CreateManySessionsInput}
Response
{
"data": {
"createManySessions": [
{
"capacity": 987,
"countIssued": 987,
"countPending": 987,
"created": "2023-01-01T00:00:00.000Z",
"doors": "2023-01-01T00:00:00.000Z",
"end": "2023-01-01T00:00:00.000Z",
"event": Event,
"eventId": "abc123",
"id": "4",
"offsale": "2023-01-01T00:00:00.000Z",
"onsale": "2023-01-01T00:00:00.000Z",
"sales": "123.45",
"sessionTicketTypes": [SessionTicketType],
"start": "2023-01-01T00:00:00.000Z",
"updated": "2023-01-01T00:00:00.000Z",
"venue": Venue
}
]
}
}
createManyTicketTypes
Response
Returns
[TicketType!]!
Arguments
| Name | Description |
|---|---|
input
-
CreateManyTicketTypesInput!
|
Example
Query
mutation CreateManyTicketTypes($input: CreateManyTicketTypesInput!) {
createManyTicketTypes(input: $input) {
bookingFee
created
id
name
price
sessionTicketTypes {
bookingFee
capacity
countIssued
countPending
enabled
price
sales
session {
...SessionFragment
}
sessionId
ticketType {
...TicketTypeFragment
}
ticketTypeId
}
sort
updated
}
}
Variables
{"input": CreateManyTicketTypesInput}
Response
{
"data": {
"createManyTicketTypes": [
{
"bookingFee": "123.45",
"created": "2023-01-01T00:00:00.000Z",
"id": "4",
"name": "abc123",
"price": "123.45",
"sessionTicketTypes": [SessionTicketType],
"sort": 123,
"updated": "2023-01-01T00:00:00.000Z"
}
]
}
}
createManyUsers
Response
Returns
[User!]!
Arguments
| Name | Description |
|---|---|
input
-
CreateManyUsersInput!
|
Example
Query
mutation CreateManyUsers($input: CreateManyUsersInput!) {
createManyUsers(input: $input) {
created
email
firstName
id
lastLogin
lastName
updated
}
}
Variables
{"input": CreateManyUsersInput}
Response
{
"data": {
"createManyUsers": [
{
"created": "2023-01-01T00:00:00.000Z",
"email": "abc123",
"firstName": "xyz789",
"id": "4",
"lastLogin": "2023-01-01T00:00:00.000Z",
"lastName": "abc123",
"updated": "2023-01-01T00:00:00.000Z"
}
]
}
}
createManyVenues
Response
Returns
[Venue!]!
Arguments
| Name | Description |
|---|---|
input
-
CreateManyVenuesInput!
|
Example
Query
mutation CreateManyVenues($input: CreateManyVenuesInput!) {
createManyVenues(input: $input) {
address
capacity
city
country
created
id
latLong
name
postalCode
sessions {
capacity
countIssued
countPending
created
doors
end
event {
...EventFragment
}
eventId
id
offsale
onsale
sales
sessionTicketTypes {
...SessionTicketTypeFragment
}
start
updated
venue {
...VenueFragment
}
}
space
state
suburb
timezone
updated
}
}
Variables
{"input": CreateManyVenuesInput}
Response
{
"data": {
"createManyVenues": [
{
"address": "xyz789",
"capacity": 987,
"city": "xyz789",
"country": "abc123",
"created": "2023-01-01T00:00:00.000Z",
"id": 4,
"latLong": "xyz789",
"name": "abc123",
"postalCode": "xyz789",
"sessions": [Session],
"space": "abc123",
"state": "xyz789",
"suburb": "abc123",
"timezone": "abc123",
"updated": "2023-01-01T00:00:00.000Z"
}
]
}
}
createOneEvent
Response
Returns an
Event!
Arguments
| Name | Description |
|---|---|
input
-
CreateOneEventInput!
|
Example
Query
mutation CreateOneEvent($input: CreateOneEventInput!) {
createOneEvent(input: $input) {
created
descriptionHtml
id
name
sessions {
edges {
...SessionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
status
updated
}
}
Variables
{"input": CreateOneEventInput}
Response
{
"data": {
"createOneEvent": {
"created": "2023-01-01T00:00:00.000Z",
"descriptionHtml": "<p>The event description.</p>",
"id": 4,
"name": "The Event Name",
"sessions": EventSessionsConnection,
"status": "4",
"updated": "2023-01-01T00:00:00.000Z"
}
}
}
createOneSession
Response
Returns a
Session!
Arguments
| Name | Description |
|---|---|
input
-
CreateOneSessionInput!
|
Example
Query
mutation CreateOneSession($input: CreateOneSessionInput!) {
createOneSession(input: $input) {
capacity
countIssued
countPending
created
doors
end
event {
created
descriptionHtml
id
name
sessions {
...EventSessionsConnectionFragment
}
status
updated
}
eventId
id
offsale
onsale
sales
sessionTicketTypes {
bookingFee
capacity
countIssued
countPending
enabled
price
sales
session {
...SessionFragment
}
sessionId
ticketType {
...TicketTypeFragment
}
ticketTypeId
}
start
updated
venue {
address
capacity
city
country
created
id
latLong
name
postalCode
sessions {
...SessionFragment
}
space
state
suburb
timezone
updated
}
}
}
Variables
{"input": CreateOneSessionInput}
Response
{
"data": {
"createOneSession": {
"capacity": 123,
"countIssued": 123,
"countPending": 987,
"created": "2023-01-01T00:00:00.000Z",
"doors": "2023-01-01T00:00:00.000Z",
"end": "2023-01-01T00:00:00.000Z",
"event": Event,
"eventId": "abc123",
"id": 4,
"offsale": "2023-01-01T00:00:00.000Z",
"onsale": "2023-01-01T00:00:00.000Z",
"sales": "123.45",
"sessionTicketTypes": [SessionTicketType],
"start": "2023-01-01T00:00:00.000Z",
"updated": "2023-01-01T00:00:00.000Z",
"venue": Venue
}
}
}
createOneSessionTicketType
Response
Returns a
SessionTicketType!
Arguments
| Name | Description |
|---|---|
input
-
CreateOneSessionTicketTypeInput!
|
Example
Query
mutation CreateOneSessionTicketType($input: CreateOneSessionTicketTypeInput!) {
createOneSessionTicketType(input: $input) {
bookingFee
capacity
countIssued
countPending
enabled
price
sales
session {
capacity
countIssued
countPending
created
doors
end
event {
...EventFragment
}
eventId
id
offsale
onsale
sales
sessionTicketTypes {
...SessionTicketTypeFragment
}
start
updated
venue {
...VenueFragment
}
}
sessionId
ticketType {
bookingFee
created
id
name
price
sessionTicketTypes {
...SessionTicketTypeFragment
}
sort
updated
}
ticketTypeId
}
}
Variables
{"input": CreateOneSessionTicketTypeInput}
Response
{
"data": {
"createOneSessionTicketType": {
"bookingFee": "123.45",
"capacity": 123,
"countIssued": 987,
"countPending": 987,
"enabled": false,
"price": "123.45",
"sales": "123.45",
"session": Session,
"sessionId": "4",
"ticketType": TicketType,
"ticketTypeId": 4
}
}
}
createOneTicketType
Response
Returns a
TicketType!
Arguments
| Name | Description |
|---|---|
input
-
CreateOneTicketTypeInput!
|
Example
Query
mutation CreateOneTicketType($input: CreateOneTicketTypeInput!) {
createOneTicketType(input: $input) {
bookingFee
created
id
name
price
sessionTicketTypes {
bookingFee
capacity
countIssued
countPending
enabled
price
sales
session {
...SessionFragment
}
sessionId
ticketType {
...TicketTypeFragment
}
ticketTypeId
}
sort
updated
}
}
Variables
{"input": CreateOneTicketTypeInput}
Response
{
"data": {
"createOneTicketType": {
"bookingFee": "123.45",
"created": "2023-01-01T00:00:00.000Z",
"id": 4,
"name": "abc123",
"price": "123.45",
"sessionTicketTypes": [SessionTicketType],
"sort": 987,
"updated": "2023-01-01T00:00:00.000Z"
}
}
}
createOneUser
Response
Returns a
User!
Arguments
| Name | Description |
|---|---|
input
-
CreateOneUserInput!
|
Example
Query
mutation CreateOneUser($input: CreateOneUserInput!) {
createOneUser(input: $input) {
created
email
firstName
id
lastLogin
lastName
updated
}
}
Variables
{"input": CreateOneUserInput}
Response
{
"data": {
"createOneUser": {
"created": "2023-01-01T00:00:00.000Z",
"email": "abc123",
"firstName": "xyz789",
"id": 4,
"lastLogin": "2023-01-01T00:00:00.000Z",
"lastName": "xyz789",
"updated": "2023-01-01T00:00:00.000Z"
}
}
}
createOneVenue
Response
Returns a
Venue!
Arguments
| Name | Description |
|---|---|
input
-
CreateOneVenueInput!
|
Example
Query
mutation CreateOneVenue($input: CreateOneVenueInput!) {
createOneVenue(input: $input) {
address
capacity
city
country
created
id
latLong
name
postalCode
sessions {
capacity
countIssued
countPending
created
doors
end
event {
...EventFragment
}
eventId
id
offsale
onsale
sales
sessionTicketTypes {
...SessionTicketTypeFragment
}
start
updated
venue {
...VenueFragment
}
}
space
state
suburb
timezone
updated
}
}
Variables
{"input": CreateOneVenueInput}
Response
{
"data": {
"createOneVenue": {
"address": "abc123",
"capacity": 987,
"city": "xyz789",
"country": "abc123",
"created": "2023-01-01T00:00:00.000Z",
"id": 4,
"latLong": "xyz789",
"name": "abc123",
"postalCode": "abc123",
"sessions": [Session],
"space": "xyz789",
"state": "abc123",
"suburb": "abc123",
"timezone": "abc123",
"updated": "2023-01-01T00:00:00.000Z"
}
}
}
createOrUpdateSessionTicketTypes
Response
Returns an
Int!
Arguments
| Name | Description |
|---|---|
input
-
CreateOrUpdateSessionTicketTypesInput!
|
Example
Query
mutation CreateOrUpdateSessionTicketTypes($input: CreateOrUpdateSessionTicketTypesInput!) {
createOrUpdateSessionTicketTypes(input: $input)
}
Variables
{"input": CreateOrUpdateSessionTicketTypesInput}
Response
{"data": {"createOrUpdateSessionTicketTypes": 123}}
createStripeAccountLink
Response
Returns a
String!
Example
Query
mutation CreateStripeAccountLink {
createStripeAccountLink
}
Response
{
"data": {
"createStripeAccountLink": "xyz789"
}
}
deleteManyEvents
Response
Returns a
DeleteManyResponse!
Arguments
| Name | Description |
|---|---|
input
-
DeleteManyEventsInput!
|
Example
Query
mutation DeleteManyEvents($input: DeleteManyEventsInput!) {
deleteManyEvents(input: $input) {
deletedCount
}
}
Variables
{"input": DeleteManyEventsInput}
Response
{"data": {"deleteManyEvents": {"deletedCount": 123}}}
deleteManySessionTicketTypes
Response
Returns a
DeleteManyResponse!
Arguments
| Name | Description |
|---|---|
input
-
DeleteManySessionTicketTypesInput!
|
Example
Query
mutation DeleteManySessionTicketTypes($input: DeleteManySessionTicketTypesInput!) {
deleteManySessionTicketTypes(input: $input) {
deletedCount
}
}
Variables
{"input": DeleteManySessionTicketTypesInput}
Response
{"data": {"deleteManySessionTicketTypes": {"deletedCount": 123}}}
deleteManySessions
Response
Returns a
DeleteManyResponse!
Arguments
| Name | Description |
|---|---|
input
-
DeleteManySessionsInput!
|
Example
Query
mutation DeleteManySessions($input: DeleteManySessionsInput!) {
deleteManySessions(input: $input) {
deletedCount
}
}
Variables
{"input": DeleteManySessionsInput}
Response
{"data": {"deleteManySessions": {"deletedCount": 987}}}
deleteManyTicketTypes
Response
Returns a
DeleteManyResponse!
Arguments
| Name | Description |
|---|---|
input
-
DeleteManyTicketTypesInput!
|
Example
Query
mutation DeleteManyTicketTypes($input: DeleteManyTicketTypesInput!) {
deleteManyTicketTypes(input: $input) {
deletedCount
}
}
Variables
{"input": DeleteManyTicketTypesInput}
Response
{"data": {"deleteManyTicketTypes": {"deletedCount": 123}}}
deleteManyUsers
Response
Returns a
DeleteManyResponse!
Arguments
| Name | Description |
|---|---|
input
-
DeleteManyUsersInput!
|
Example
Query
mutation DeleteManyUsers($input: DeleteManyUsersInput!) {
deleteManyUsers(input: $input) {
deletedCount
}
}
Variables
{"input": DeleteManyUsersInput}
Response
{"data": {"deleteManyUsers": {"deletedCount": 987}}}
deleteManyVenues
Response
Returns a
DeleteManyResponse!
Arguments
| Name | Description |
|---|---|
input
-
DeleteManyVenuesInput!
|
Example
Query
mutation DeleteManyVenues($input: DeleteManyVenuesInput!) {
deleteManyVenues(input: $input) {
deletedCount
}
}
Variables
{"input": DeleteManyVenuesInput}
Response
{"data": {"deleteManyVenues": {"deletedCount": 123}}}
deleteOneEvent
Response
Returns an
EventDeleteResponse!
Arguments
| Name | Description |
|---|---|
input
-
DeleteOneEventInput!
|
Example
Query
mutation DeleteOneEvent($input: DeleteOneEventInput!) {
deleteOneEvent(input: $input) {
created
descriptionHtml
id
name
status
updated
}
}
Variables
{"input": DeleteOneEventInput}
Response
{
"data": {
"deleteOneEvent": {
"created": "2023-01-01T00:00:00.000Z",
"descriptionHtml": "xyz789",
"id": "4",
"name": 4,
"status": "4",
"updated": "2023-01-01T00:00:00.000Z"
}
}
}
deleteOneSession
Response
Returns a
SessionDeleteResponse!
Arguments
| Name | Description |
|---|---|
input
-
DeleteOneSessionInput!
|
Example
Query
mutation DeleteOneSession($input: DeleteOneSessionInput!) {
deleteOneSession(input: $input) {
capacity
created
doors
end
eventId
id
offsale
onsale
start
updated
}
}
Variables
{"input": DeleteOneSessionInput}
Response
{
"data": {
"deleteOneSession": {
"capacity": 987,
"created": "2023-01-01T00:00:00.000Z",
"doors": "2023-01-01T00:00:00.000Z",
"end": "2023-01-01T00:00:00.000Z",
"eventId": "xyz789",
"id": "4",
"offsale": "2023-01-01T00:00:00.000Z",
"onsale": "2023-01-01T00:00:00.000Z",
"start": "2023-01-01T00:00:00.000Z",
"updated": "2023-01-01T00:00:00.000Z"
}
}
}
deleteOneSessionTicketType
Response
Returns a
SessionTicketTypeDeleteResponse!
Arguments
| Name | Description |
|---|---|
input
-
DeleteOneSessionTicketTypeInput!
|
Example
Query
mutation DeleteOneSessionTicketType($input: DeleteOneSessionTicketTypeInput!) {
deleteOneSessionTicketType(input: $input) {
bookingFee
capacity
enabled
price
sessionId
ticketTypeId
}
}
Variables
{"input": DeleteOneSessionTicketTypeInput}
Response
{
"data": {
"deleteOneSessionTicketType": {
"bookingFee": "123.45",
"capacity": 987,
"enabled": true,
"price": "123.45",
"sessionId": 4,
"ticketTypeId": "4"
}
}
}
deleteOneTicketType
Response
Returns a
TicketTypeDeleteResponse!
Arguments
| Name | Description |
|---|---|
input
-
DeleteOneTicketTypeInput!
|
Example
Query
mutation DeleteOneTicketType($input: DeleteOneTicketTypeInput!) {
deleteOneTicketType(input: $input) {
bookingFee
created
id
name
price
sessionTicketTypes {
bookingFee
capacity
countIssued
countPending
enabled
price
sales
session {
...SessionFragment
}
sessionId
ticketType {
...TicketTypeFragment
}
ticketTypeId
}
sort
updated
}
}
Variables
{"input": DeleteOneTicketTypeInput}
Response
{
"data": {
"deleteOneTicketType": {
"bookingFee": "123.45",
"created": "2023-01-01T00:00:00.000Z",
"id": 4,
"name": "xyz789",
"price": "123.45",
"sessionTicketTypes": [SessionTicketType],
"sort": 123,
"updated": "2023-01-01T00:00:00.000Z"
}
}
}
deleteOneUser
Response
Returns a
UserDeleteResponse!
Arguments
| Name | Description |
|---|---|
input
-
DeleteOneUserInput!
|
Example
Query
mutation DeleteOneUser($input: DeleteOneUserInput!) {
deleteOneUser(input: $input) {
created
email
firstName
id
lastLogin
lastName
updated
}
}
Variables
{"input": DeleteOneUserInput}
Response
{
"data": {
"deleteOneUser": {
"created": "2023-01-01T00:00:00.000Z",
"email": "xyz789",
"firstName": "xyz789",
"id": 4,
"lastLogin": "2023-01-01T00:00:00.000Z",
"lastName": "xyz789",
"updated": "2023-01-01T00:00:00.000Z"
}
}
}
deleteOneVenue
Response
Returns a
VenueDeleteResponse!
Arguments
| Name | Description |
|---|---|
input
-
DeleteOneVenueInput!
|
Example
Query
mutation DeleteOneVenue($input: DeleteOneVenueInput!) {
deleteOneVenue(input: $input) {
address
capacity
city
country
created
id
latLong
name
postalCode
sessions {
capacity
countIssued
countPending
created
doors
end
event {
...EventFragment
}
eventId
id
offsale
onsale
sales
sessionTicketTypes {
...SessionTicketTypeFragment
}
start
updated
venue {
...VenueFragment
}
}
space
state
suburb
timezone
updated
}
}
Variables
{"input": DeleteOneVenueInput}
Response
{
"data": {
"deleteOneVenue": {
"address": "xyz789",
"capacity": 987,
"city": "xyz789",
"country": "abc123",
"created": "2023-01-01T00:00:00.000Z",
"id": "4",
"latLong": "abc123",
"name": "abc123",
"postalCode": "xyz789",
"sessions": [Session],
"space": "abc123",
"state": "abc123",
"suburb": "xyz789",
"timezone": "abc123",
"updated": "2023-01-01T00:00:00.000Z"
}
}
}
removeSessionTicketTypesFromSession
Response
Returns a
Session!
Arguments
| Name | Description |
|---|---|
input
-
RemoveSessionTicketTypesFromSessionInput!
|
Example
Query
mutation RemoveSessionTicketTypesFromSession($input: RemoveSessionTicketTypesFromSessionInput!) {
removeSessionTicketTypesFromSession(input: $input) {
capacity
countIssued
countPending
created
doors
end
event {
created
descriptionHtml
id
name
sessions {
...EventSessionsConnectionFragment
}
status
updated
}
eventId
id
offsale
onsale
sales
sessionTicketTypes {
bookingFee
capacity
countIssued
countPending
enabled
price
sales
session {
...SessionFragment
}
sessionId
ticketType {
...TicketTypeFragment
}
ticketTypeId
}
start
updated
venue {
address
capacity
city
country
created
id
latLong
name
postalCode
sessions {
...SessionFragment
}
space
state
suburb
timezone
updated
}
}
}
Variables
{"input": RemoveSessionTicketTypesFromSessionInput}
Response
{
"data": {
"removeSessionTicketTypesFromSession": {
"capacity": 987,
"countIssued": 123,
"countPending": 987,
"created": "2023-01-01T00:00:00.000Z",
"doors": "2023-01-01T00:00:00.000Z",
"end": "2023-01-01T00:00:00.000Z",
"event": Event,
"eventId": "xyz789",
"id": "4",
"offsale": "2023-01-01T00:00:00.000Z",
"onsale": "2023-01-01T00:00:00.000Z",
"sales": "123.45",
"sessionTicketTypes": [SessionTicketType],
"start": "2023-01-01T00:00:00.000Z",
"updated": "2023-01-01T00:00:00.000Z",
"venue": Venue
}
}
}
removeSessionTicketTypesFromTicketType
Response
Returns a
TicketType!
Arguments
| Name | Description |
|---|---|
input
-
RemoveSessionTicketTypesFromTicketTypeInput!
|
Example
Query
mutation RemoveSessionTicketTypesFromTicketType($input: RemoveSessionTicketTypesFromTicketTypeInput!) {
removeSessionTicketTypesFromTicketType(input: $input) {
bookingFee
created
id
name
price
sessionTicketTypes {
bookingFee
capacity
countIssued
countPending
enabled
price
sales
session {
...SessionFragment
}
sessionId
ticketType {
...TicketTypeFragment
}
ticketTypeId
}
sort
updated
}
}
Variables
{"input": RemoveSessionTicketTypesFromTicketTypeInput}
Response
{
"data": {
"removeSessionTicketTypesFromTicketType": {
"bookingFee": "123.45",
"created": "2023-01-01T00:00:00.000Z",
"id": "4",
"name": "xyz789",
"price": "123.45",
"sessionTicketTypes": [SessionTicketType],
"sort": 123,
"updated": "2023-01-01T00:00:00.000Z"
}
}
}
reorderTicketTypes
Response
Returns an
Int!
Arguments
| Name | Description |
|---|---|
input
-
ReorderInput!
|
Example
Query
mutation ReorderTicketTypes($input: ReorderInput!) {
reorderTicketTypes(input: $input)
}
Variables
{"input": ReorderInput}
Response
{"data": {"reorderTicketTypes": 987}}
resendOrder
Description
Resend an order to a customer's email.
setSessionTicketTypesOnSession
Response
Returns a
Session!
Arguments
| Name | Description |
|---|---|
input
-
SetSessionTicketTypesOnSessionInput!
|
Example
Query
mutation SetSessionTicketTypesOnSession($input: SetSessionTicketTypesOnSessionInput!) {
setSessionTicketTypesOnSession(input: $input) {
capacity
countIssued
countPending
created
doors
end
event {
created
descriptionHtml
id
name
sessions {
...EventSessionsConnectionFragment
}
status
updated
}
eventId
id
offsale
onsale
sales
sessionTicketTypes {
bookingFee
capacity
countIssued
countPending
enabled
price
sales
session {
...SessionFragment
}
sessionId
ticketType {
...TicketTypeFragment
}
ticketTypeId
}
start
updated
venue {
address
capacity
city
country
created
id
latLong
name
postalCode
sessions {
...SessionFragment
}
space
state
suburb
timezone
updated
}
}
}
Variables
{"input": SetSessionTicketTypesOnSessionInput}
Response
{
"data": {
"setSessionTicketTypesOnSession": {
"capacity": 987,
"countIssued": 987,
"countPending": 987,
"created": "2023-01-01T00:00:00.000Z",
"doors": "2023-01-01T00:00:00.000Z",
"end": "2023-01-01T00:00:00.000Z",
"event": Event,
"eventId": "abc123",
"id": "4",
"offsale": "2023-01-01T00:00:00.000Z",
"onsale": "2023-01-01T00:00:00.000Z",
"sales": "123.45",
"sessionTicketTypes": [SessionTicketType],
"start": "2023-01-01T00:00:00.000Z",
"updated": "2023-01-01T00:00:00.000Z",
"venue": Venue
}
}
}
setSessionTicketTypesOnTicketType
Response
Returns a
TicketType!
Arguments
| Name | Description |
|---|---|
input
-
SetSessionTicketTypesOnTicketTypeInput!
|
Example
Query
mutation SetSessionTicketTypesOnTicketType($input: SetSessionTicketTypesOnTicketTypeInput!) {
setSessionTicketTypesOnTicketType(input: $input) {
bookingFee
created
id
name
price
sessionTicketTypes {
bookingFee
capacity
countIssued
countPending
enabled
price
sales
session {
...SessionFragment
}
sessionId
ticketType {
...TicketTypeFragment
}
ticketTypeId
}
sort
updated
}
}
Variables
{"input": SetSessionTicketTypesOnTicketTypeInput}
Response
{
"data": {
"setSessionTicketTypesOnTicketType": {
"bookingFee": "123.45",
"created": "2023-01-01T00:00:00.000Z",
"id": "4",
"name": "xyz789",
"price": "123.45",
"sessionTicketTypes": [SessionTicketType],
"sort": 123,
"updated": "2023-01-01T00:00:00.000Z"
}
}
}
updateAccount
Response
Returns an
Account!
Arguments
| Name | Description |
|---|---|
input
-
AccountInput!
|
Example
Query
mutation UpdateAccount($input: AccountInput!) {
updateAccount(input: $input) {
billingExpiry
billingInterval
billingPriceId
billingSubscriptionId
created
currency
events {
created
descriptionHtml
id
name
sessions {
...EventSessionsConnectionFragment
}
status
updated
}
locale
name
sessions {
capacity
countIssued
countPending
created
doors
end
event {
...EventFragment
}
eventId
id
offsale
onsale
sales
sessionTicketTypes {
...SessionTicketTypeFragment
}
start
updated
venue {
...VenueFragment
}
}
ticketTypes {
bookingFee
created
id
name
price
sessionTicketTypes {
...SessionTicketTypeFragment
}
sort
updated
}
updated
url
users {
created
email
firstName
id
lastLogin
lastName
updated
}
}
}
Variables
{"input": AccountInput}
Response
{
"data": {
"updateAccount": {
"billingExpiry": "2023-01-01T00:00:00.000Z",
"billingInterval": "abc123",
"billingPriceId": "xyz789",
"billingSubscriptionId": "xyz789",
"created": "2023-01-01T00:00:00.000Z",
"currency": "USD",
"events": [Event],
"locale": "en-US",
"name": "Stark Industries",
"sessions": [Session],
"ticketTypes": [TicketType],
"updated": "2023-01-01T00:00:00.000Z",
"url": "stark.example.com",
"users": [User]
}
}
}
updateManyEvents
Response
Returns an
UpdateManyResponse!
Arguments
| Name | Description |
|---|---|
input
-
UpdateManyEventsInput!
|
Example
Query
mutation UpdateManyEvents($input: UpdateManyEventsInput!) {
updateManyEvents(input: $input) {
updatedCount
}
}
Variables
{"input": UpdateManyEventsInput}
Response
{"data": {"updateManyEvents": {"updatedCount": 123}}}
updateManySessionTicketTypes
Response
Returns an
UpdateManyResponse!
Arguments
| Name | Description |
|---|---|
input
-
UpdateManySessionTicketTypesInput!
|
Example
Query
mutation UpdateManySessionTicketTypes($input: UpdateManySessionTicketTypesInput!) {
updateManySessionTicketTypes(input: $input) {
updatedCount
}
}
Variables
{"input": UpdateManySessionTicketTypesInput}
Response
{"data": {"updateManySessionTicketTypes": {"updatedCount": 123}}}
updateManySessions
Response
Returns an
UpdateManyResponse!
Arguments
| Name | Description |
|---|---|
input
-
UpdateManySessionsInput!
|
Example
Query
mutation UpdateManySessions($input: UpdateManySessionsInput!) {
updateManySessions(input: $input) {
updatedCount
}
}
Variables
{"input": UpdateManySessionsInput}
Response
{"data": {"updateManySessions": {"updatedCount": 987}}}
updateManyTicketTypes
Response
Returns an
UpdateManyResponse!
Arguments
| Name | Description |
|---|---|
input
-
UpdateManyTicketTypesInput!
|
Example
Query
mutation UpdateManyTicketTypes($input: UpdateManyTicketTypesInput!) {
updateManyTicketTypes(input: $input) {
updatedCount
}
}
Variables
{"input": UpdateManyTicketTypesInput}
Response
{"data": {"updateManyTicketTypes": {"updatedCount": 123}}}
updateManyUsers
Response
Returns an
UpdateManyResponse!
Arguments
| Name | Description |
|---|---|
input
-
UpdateManyUsersInput!
|
Example
Query
mutation UpdateManyUsers($input: UpdateManyUsersInput!) {
updateManyUsers(input: $input) {
updatedCount
}
}
Variables
{"input": UpdateManyUsersInput}
Response
{"data": {"updateManyUsers": {"updatedCount": 123}}}
updateManyVenues
Response
Returns an
UpdateManyResponse!
Arguments
| Name | Description |
|---|---|
input
-
UpdateManyVenuesInput!
|
Example
Query
mutation UpdateManyVenues($input: UpdateManyVenuesInput!) {
updateManyVenues(input: $input) {
updatedCount
}
}
Variables
{"input": UpdateManyVenuesInput}
Response
{"data": {"updateManyVenues": {"updatedCount": 123}}}
updateOneEvent
Response
Returns an
Event!
Arguments
| Name | Description |
|---|---|
input
-
UpdateOneEventInput!
|
Example
Query
mutation UpdateOneEvent($input: UpdateOneEventInput!) {
updateOneEvent(input: $input) {
created
descriptionHtml
id
name
sessions {
edges {
...SessionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
status
updated
}
}
Variables
{"input": UpdateOneEventInput}
Response
{
"data": {
"updateOneEvent": {
"created": "2023-01-01T00:00:00.000Z",
"descriptionHtml": "<p>The event description.</p>",
"id": "4",
"name": "The Event Name",
"sessions": EventSessionsConnection,
"status": "4",
"updated": "2023-01-01T00:00:00.000Z"
}
}
}
updateOneSession
Response
Returns a
Session!
Arguments
| Name | Description |
|---|---|
input
-
UpdateOneSessionInput!
|
Example
Query
mutation UpdateOneSession($input: UpdateOneSessionInput!) {
updateOneSession(input: $input) {
capacity
countIssued
countPending
created
doors
end
event {
created
descriptionHtml
id
name
sessions {
...EventSessionsConnectionFragment
}
status
updated
}
eventId
id
offsale
onsale
sales
sessionTicketTypes {
bookingFee
capacity
countIssued
countPending
enabled
price
sales
session {
...SessionFragment
}
sessionId
ticketType {
...TicketTypeFragment
}
ticketTypeId
}
start
updated
venue {
address
capacity
city
country
created
id
latLong
name
postalCode
sessions {
...SessionFragment
}
space
state
suburb
timezone
updated
}
}
}
Variables
{"input": UpdateOneSessionInput}
Response
{
"data": {
"updateOneSession": {
"capacity": 123,
"countIssued": 123,
"countPending": 987,
"created": "2023-01-01T00:00:00.000Z",
"doors": "2023-01-01T00:00:00.000Z",
"end": "2023-01-01T00:00:00.000Z",
"event": Event,
"eventId": "xyz789",
"id": 4,
"offsale": "2023-01-01T00:00:00.000Z",
"onsale": "2023-01-01T00:00:00.000Z",
"sales": "123.45",
"sessionTicketTypes": [SessionTicketType],
"start": "2023-01-01T00:00:00.000Z",
"updated": "2023-01-01T00:00:00.000Z",
"venue": Venue
}
}
}
updateOneSessionTicketType
Response
Returns a
SessionTicketType!
Arguments
| Name | Description |
|---|---|
input
-
UpdateOneSessionTicketTypeInput!
|
Example
Query
mutation UpdateOneSessionTicketType($input: UpdateOneSessionTicketTypeInput!) {
updateOneSessionTicketType(input: $input) {
bookingFee
capacity
countIssued
countPending
enabled
price
sales
session {
capacity
countIssued
countPending
created
doors
end
event {
...EventFragment
}
eventId
id
offsale
onsale
sales
sessionTicketTypes {
...SessionTicketTypeFragment
}
start
updated
venue {
...VenueFragment
}
}
sessionId
ticketType {
bookingFee
created
id
name
price
sessionTicketTypes {
...SessionTicketTypeFragment
}
sort
updated
}
ticketTypeId
}
}
Variables
{"input": UpdateOneSessionTicketTypeInput}
Response
{
"data": {
"updateOneSessionTicketType": {
"bookingFee": "123.45",
"capacity": 123,
"countIssued": 123,
"countPending": 123,
"enabled": true,
"price": "123.45",
"sales": "123.45",
"session": Session,
"sessionId": 4,
"ticketType": TicketType,
"ticketTypeId": 4
}
}
}
updateOneTicketType
Response
Returns a
TicketType!
Arguments
| Name | Description |
|---|---|
input
-
UpdateOneTicketTypeInput!
|
Example
Query
mutation UpdateOneTicketType($input: UpdateOneTicketTypeInput!) {
updateOneTicketType(input: $input) {
bookingFee
created
id
name
price
sessionTicketTypes {
bookingFee
capacity
countIssued
countPending
enabled
price
sales
session {
...SessionFragment
}
sessionId
ticketType {
...TicketTypeFragment
}
ticketTypeId
}
sort
updated
}
}
Variables
{"input": UpdateOneTicketTypeInput}
Response
{
"data": {
"updateOneTicketType": {
"bookingFee": "123.45",
"created": "2023-01-01T00:00:00.000Z",
"id": "4",
"name": "xyz789",
"price": "123.45",
"sessionTicketTypes": [SessionTicketType],
"sort": 987,
"updated": "2023-01-01T00:00:00.000Z"
}
}
}
updateOneUser
Response
Returns a
User!
Arguments
| Name | Description |
|---|---|
input
-
UpdateOneUserInput!
|
Example
Query
mutation UpdateOneUser($input: UpdateOneUserInput!) {
updateOneUser(input: $input) {
created
email
firstName
id
lastLogin
lastName
updated
}
}
Variables
{"input": UpdateOneUserInput}
Response
{
"data": {
"updateOneUser": {
"created": "2023-01-01T00:00:00.000Z",
"email": "xyz789",
"firstName": "abc123",
"id": "4",
"lastLogin": "2023-01-01T00:00:00.000Z",
"lastName": "xyz789",
"updated": "2023-01-01T00:00:00.000Z"
}
}
}
updateOneVenue
Response
Returns a
Venue!
Arguments
| Name | Description |
|---|---|
input
-
UpdateOneVenueInput!
|
Example
Query
mutation UpdateOneVenue($input: UpdateOneVenueInput!) {
updateOneVenue(input: $input) {
address
capacity
city
country
created
id
latLong
name
postalCode
sessions {
capacity
countIssued
countPending
created
doors
end
event {
...EventFragment
}
eventId
id
offsale
onsale
sales
sessionTicketTypes {
...SessionTicketTypeFragment
}
start
updated
venue {
...VenueFragment
}
}
space
state
suburb
timezone
updated
}
}
Variables
{"input": UpdateOneVenueInput}
Response
{
"data": {
"updateOneVenue": {
"address": "abc123",
"capacity": 123,
"city": "abc123",
"country": "xyz789",
"created": "2023-01-01T00:00:00.000Z",
"id": 4,
"latLong": "abc123",
"name": "xyz789",
"postalCode": "abc123",
"sessions": [Session],
"space": "abc123",
"state": "abc123",
"suburb": "xyz789",
"timezone": "xyz789",
"updated": "2023-01-01T00:00:00.000Z"
}
}
}
updateStripeGateway
Response
Returns a
PaymentGateway!
Arguments
| Name | Description |
|---|---|
input
-
PaymentGatewayInput!
|
Example
Query
mutation UpdateStripeGateway($input: PaymentGatewayInput!) {
updateStripeGateway(input: $input) {
created
feeFixed
feeMatch
feePercent
provider
updated
}
}
Variables
{"input": PaymentGatewayInput}
Response
{
"data": {
"updateStripeGateway": {
"created": "2023-01-01T00:00:00.000Z",
"feeFixed": "123.45",
"feeMatch": true,
"feePercent": 123.45,
"provider": "BRAINTREE",
"updated": "2023-01-01T00:00:00.000Z"
}
}
}
Types
Account
Description
The account represents your organisation.
Fields
| Field Name | Description |
|---|---|
billingExpiry
-
DateTime
|
The expiry date of the current billing subscription plan. |
billingInterval
-
String
|
The current subscription billing interval ('month' or 'year') if applicable. |
billingPriceId
-
String
|
The third-party billing price ID of the current subscription plan. |
billingSubscriptionId
-
String
|
The third-party billing current subscription ID for the account. |
created
-
DateTime
|
When the account was created. |
currency
-
String!
|
The currency of the account. |
events
-
[Event!]!
|
Events associated with the account. |
locale
-
String!
|
The locale of the account. |
name -
String!
|
The name of the account. |
sessions
-
[Session!]!
|
Sessions associated with the account. |
ticketTypes
-
[TicketType!]!
|
Ticket types associated with the account. |
updated
-
DateTime
|
When the account was last updated. |
url -
String!
|
The URL of the account. |
users
-
[User!]!
|
Users associated with the account. |
Example
{
"billingExpiry": "2023-01-01T00:00:00.000Z",
"billingInterval": "xyz789",
"billingPriceId": "xyz789",
"billingSubscriptionId": "xyz789",
"created": "2023-01-01T00:00:00.000Z",
"currency": "USD",
"events": [Event],
"locale": "en-US",
"name": "Stark Industries",
"sessions": [Session],
"ticketTypes": [TicketType],
"updated": "2023-01-01T00:00:00.000Z",
"url": "stark.example.com",
"users": [User]
}
AccountInput
AddSessionTicketTypesToSessionInput
AddSessionTicketTypesToTicketTypeInput
BillingInvoice
Description
An invoice
Example
{
"amount": "123.45",
"date": "2023-01-01T00:00:00.000Z",
"id": "xyz789",
"status": "abc123",
"url": "xyz789"
}
BillingPlan
Description
A subscription plan option.
Fields
| Field Name | Description |
|---|---|
description
-
String!
|
The description of the plan. |
id -
String!
|
The ID of the plan. |
name -
String!
|
The name of the plan. |
terms
-
[BillingPlanTerm!]!
|
The billing term options for this plan. |
Example
{
"description": "abc123",
"id": "abc123",
"name": "abc123",
"terms": [BillingPlanTerm]
}
BillingPlanTerm
Description
A subscription plan billing term.
Example
{
"currency": "xyz789",
"id": "xyz789",
"period": "xyz789",
"price": "123.45"
}
Boolean
Description
The Boolean scalar type represents
true or false.
BooleanFieldComparison
ConnectionCursor
Description
Cursor for paging through collections
Example
ConnectionCursor
CreateManyEventsInput
Fields
| Input Field | Description |
|---|---|
events
-
[EventInput!]!
|
Array of records to create |
Example
{"events": [EventInput]}
CreateManySessionTicketTypesInput
Fields
| Input Field | Description |
|---|---|
sessionTicketTypes
-
[SessionTicketTypeInput!]!
|
Array of records to create |
Example
{"sessionTicketTypes": [SessionTicketTypeInput]}
CreateManySessionsInput
Fields
| Input Field | Description |
|---|---|
sessions
-
[CreateSessionInput!]!
|
Array of records to create |
Example
{"sessions": [CreateSessionInput]}
CreateManyTicketTypesInput
Fields
| Input Field | Description |
|---|---|
ticketTypes
-
[TicketTypeInput!]!
|
Array of records to create |
Example
{"ticketTypes": [TicketTypeInput]}
CreateManyUsersInput
Fields
| Input Field | Description |
|---|---|
users
-
[UserInput!]!
|
Array of records to create |
Example
{"users": [UserInput]}
CreateManyVenuesInput
Fields
| Input Field | Description |
|---|---|
venues
-
[VenueInput!]!
|
Array of records to create |
Example
{"venues": [VenueInput]}
CreateOneEventInput
Fields
| Input Field | Description |
|---|---|
event
-
EventInput!
|
The record to create |
Example
{"event": EventInput}
CreateOneSessionInput
Fields
| Input Field | Description |
|---|---|
session
-
CreateSessionInput!
|
The record to create |
Example
{"session": CreateSessionInput}
CreateOneSessionTicketTypeInput
Fields
| Input Field | Description |
|---|---|
sessionTicketType
-
SessionTicketTypeInput!
|
The record to create |
Example
{"sessionTicketType": SessionTicketTypeInput}
CreateOneTicketTypeInput
Fields
| Input Field | Description |
|---|---|
ticketType
-
TicketTypeInput!
|
The record to create |
Example
{"ticketType": TicketTypeInput}
CreateOneUserInput
Fields
| Input Field | Description |
|---|---|
user -
UserInput!
|
The record to create |
Example
{"user": UserInput}
CreateOneVenueInput
Fields
| Input Field | Description |
|---|---|
venue
-
VenueInput!
|
The record to create |
Example
{"venue": VenueInput}
CreateOrUpdateSessionTicketTypesInput
Description
The inputs for a creating or updating multiple session ticket types.
Fields
| Input Field | Description |
|---|---|
sessionTicketTypes
-
[SessionTicketTypeInput!]!
|
The session ticket types. |
Example
{"sessionTicketTypes": [SessionTicketTypeInput]}
CreateSessionInput
Description
The inputs for a createSession mutation.
Fields
| Input Field | Description |
|---|---|
capacity
-
Int
|
The maximum capacity of the session. |
doors
-
DateTime
|
The door opening date and time of the session. |
end -
DateTime
|
The local end date and time of the session. |
eventId
-
ID!
|
The ID of the event the session belongs to. |
offsale
-
DateTime
|
The offsale date and time of the session. |
onsale
-
DateTime
|
The onsale date and time of the session. |
start
-
DateTime!
|
The local start date and time of the session. |
venueId
-
ID!
|
The ID of the venue the session takes place at. |
Example
{
"capacity": 987,
"doors": "2023-01-01T00:00:00.000Z",
"end": "2023-01-01T00:00:00.000Z",
"eventId": 4,
"offsale": "2023-01-01T00:00:00.000Z",
"onsale": "2023-01-01T00:00:00.000Z",
"start": "2023-01-01T00:00:00.000Z",
"venueId": 4
}
CursorPaging
Fields
| Input Field | Description |
|---|---|
after
-
ConnectionCursor
|
Paginate after opaque cursor |
before
-
ConnectionCursor
|
Paginate before opaque cursor |
first
-
Int
|
Paginate first |
last -
Int
|
Paginate last |
Example
{
"after": ConnectionCursor,
"before": ConnectionCursor,
"first": 123,
"last": 987
}
DateFieldComparison
Fields
| Input Field | Description |
|---|---|
between
-
DateFieldComparisonBetween
|
|
eq -
DateTime
|
|
gt -
DateTime
|
|
gte -
DateTime
|
|
in -
[DateTime!]
|
|
is -
Boolean
|
|
isNot
-
Boolean
|
|
lt -
DateTime
|
|
lte -
DateTime
|
|
neq -
DateTime
|
|
notBetween
-
DateFieldComparisonBetween
|
|
notIn
-
[DateTime!]
|
Example
{
"between": DateFieldComparisonBetween,
"eq": "2023-01-01T00:00:00.000Z",
"gt": "2023-01-01T00:00:00.000Z",
"gte": "2023-01-01T00:00:00.000Z",
"in": ["2023-01-01T00:00:00.000Z"],
"is": true,
"isNot": false,
"lt": "2023-01-01T00:00:00.000Z",
"lte": "2023-01-01T00:00:00.000Z",
"neq": "2023-01-01T00:00:00.000Z",
"notBetween": DateFieldComparisonBetween,
"notIn": ["2023-01-01T00:00:00.000Z"]
}
DateFieldComparisonBetween
DateTime
Description
A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.
Example
"2023-01-01T00:00:00.000Z"
DeleteManyEventsInput
Fields
| Input Field | Description |
|---|---|
filter
-
EventDeleteFilter!
|
Filter to find records to delete |
Example
{"filter": EventDeleteFilter}
DeleteManyResponse
Fields
| Field Name | Description |
|---|---|
deletedCount
-
Int!
|
The number of records deleted. |
Example
{"deletedCount": 987}
DeleteManySessionTicketTypesInput
Fields
| Input Field | Description |
|---|---|
filter
-
SessionTicketTypeDeleteFilter!
|
Filter to find records to delete |
Example
{"filter": SessionTicketTypeDeleteFilter}
DeleteManySessionsInput
Fields
| Input Field | Description |
|---|---|
filter
-
SessionDeleteFilter!
|
Filter to find records to delete |
Example
{"filter": SessionDeleteFilter}
DeleteManyTicketTypesInput
Fields
| Input Field | Description |
|---|---|
filter
-
TicketTypeDeleteFilter!
|
Filter to find records to delete |
Example
{"filter": TicketTypeDeleteFilter}
DeleteManyUsersInput
Fields
| Input Field | Description |
|---|---|
filter
-
UserDeleteFilter!
|
Filter to find records to delete |
Example
{"filter": UserDeleteFilter}
DeleteManyVenuesInput
Fields
| Input Field | Description |
|---|---|
filter
-
VenueDeleteFilter!
|
Filter to find records to delete |
Example
{"filter": VenueDeleteFilter}
DeleteOneEventInput
Fields
| Input Field | Description |
|---|---|
id -
ID!
|
The id of the record to delete. |
Example
{"id": 4}
DeleteOneSessionInput
Fields
| Input Field | Description |
|---|---|
id -
ID!
|
The id of the record to delete. |
Example
{"id": "4"}
DeleteOneSessionTicketTypeInput
Fields
| Input Field | Description |
|---|---|
id -
ID!
|
The id of the record to delete. |
Example
{"id": "4"}
DeleteOneTicketTypeInput
Fields
| Input Field | Description |
|---|---|
id -
ID!
|
The id of the record to delete. |
Example
{"id": 4}
DeleteOneUserInput
Fields
| Input Field | Description |
|---|---|
id -
ID!
|
The id of the record to delete. |
Example
{"id": 4}
DeleteOneVenueInput
Fields
| Input Field | Description |
|---|---|
id -
ID!
|
The id of the record to delete. |
Example
{"id": 4}
Event
Description
An event object contains brand and messaging content bringing together one or more sessions, shows or performances.
Fields
| Field Name | Description |
|---|---|
created
-
DateTime
|
When the event was created. |
descriptionHtml
-
String
|
The description of the event, with HTML formatting. |
id -
ID!
|
The ID of the event. |
name -
ID!
|
The name of the event. |
sessions
-
EventSessionsConnection!
|
|
Arguments
|
|
status
-
ID!
|
The event's status. |
updated
-
DateTime
|
When the event was last updated. |
Example
{
"created": "2023-01-01T00:00:00.000Z",
"descriptionHtml": "<p>The event description.</p>",
"id": 4,
"name": "The Event Name",
"sessions": EventSessionsConnection,
"status": "4",
"updated": "2023-01-01T00:00:00.000Z"
}
EventConnection
Fields
| Field Name | Description |
|---|---|
edges
-
[EventEdge!]!
|
Array of edges. |
pageInfo
-
PageInfo!
|
Paging information |
Example
{
"edges": [EventEdge],
"pageInfo": PageInfo
}
EventDeleteFilter
Fields
| Input Field | Description |
|---|---|
and -
[EventDeleteFilter!]
|
|
name -
IDFilterComparison
|
|
or -
[EventDeleteFilter!]
|
|
status
-
IDFilterComparison
|
Example
{
"and": [EventDeleteFilter],
"name": IDFilterComparison,
"or": [EventDeleteFilter],
"status": IDFilterComparison
}
EventDeleteResponse
Example
{
"created": "2023-01-01T00:00:00.000Z",
"descriptionHtml": "xyz789",
"id": 4,
"name": 4,
"status": "4",
"updated": "2023-01-01T00:00:00.000Z"
}
EventEdge
Fields
| Field Name | Description |
|---|---|
cursor
-
ConnectionCursor!
|
Cursor for this node. |
node -
Event!
|
The node containing the Event |
Example
{
"cursor": ConnectionCursor,
"node": Event
}
EventFilter
Fields
| Input Field | Description |
|---|---|
and -
[EventFilter!]
|
|
name -
IDFilterComparison
|
|
or -
[EventFilter!]
|
|
status
-
IDFilterComparison
|
Example
{
"and": [EventFilter],
"name": IDFilterComparison,
"or": [EventFilter],
"status": IDFilterComparison
}
EventInput
EventSessionsConnection
Fields
| Field Name | Description |
|---|---|
edges
-
[SessionEdge!]!
|
Array of edges. |
pageInfo
-
PageInfo!
|
Paging information |
Example
{
"edges": [SessionEdge],
"pageInfo": PageInfo
}
EventSort
Fields
| Input Field | Description |
|---|---|
direction
-
SortDirection!
|
|
field
-
EventSortFields!
|
|
nulls
-
SortNulls
|
Example
{"direction": "ASC", "field": "name", "nulls": "NULLS_FIRST"}
EventSortFields
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"name"
EventUpdateFilter
Fields
| Input Field | Description |
|---|---|
and -
[EventUpdateFilter!]
|
|
name -
IDFilterComparison
|
|
or -
[EventUpdateFilter!]
|
|
status
-
IDFilterComparison
|
Example
{
"and": [EventUpdateFilter],
"name": IDFilterComparison,
"or": [EventUpdateFilter],
"status": IDFilterComparison
}
Float
Description
The Float scalar type represents signed
double-precision fractional values as specified by
IEEE 754.
Example
987.65
GatewayCurrency
Description
The currencies supported by a payment gateway account.
Fields
| Field Name | Description |
|---|---|
default
-
String!
|
The default currency. |
supported
-
[String!]!
|
The supported payment currencies. |
Example
{
"default": "abc123",
"supported": ["abc123"]
}
ID
Description
The ID scalar type represents a unique
identifier, 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
"4") or integer (such as
4) input value will be accepted as an ID.
Example
4
IDFilterComparison
Example
{
"eq": "4",
"gt": "4",
"gte": 4,
"iLike": 4,
"in": ["4"],
"is": true,
"isNot": true,
"like": "4",
"lt": "4",
"lte": 4,
"neq": "4",
"notILike": 4,
"notIn": ["4"],
"notLike": "4"
}
Int
Description
The Int scalar type represents non-fractional
signed whole numeric values. Int can represent values
between -(2^31) and 2^31 - 1.
Example
123
IntFieldComparison
Example
{
"between": IntFieldComparisonBetween,
"eq": 123,
"gt": 987,
"gte": 987,
"in": [123],
"is": false,
"isNot": false,
"lt": 987,
"lte": 123,
"neq": 123,
"notBetween": IntFieldComparisonBetween,
"notIn": [987]
}
IntFieldComparisonBetween
Money
Description
A string representing a monetary value.
Example
"123.45"
OnboardingProgress
Description
The onboarding status of your account.
Fields
| Field Name | Description |
|---|---|
event
-
Boolean!
|
Whether an event has been added. |
eventId
-
String
|
The ID of the first event added. |
gateway
-
PaymentGatewayStatus!
|
The payment gateway status. |
onsale
-
Boolean!
|
Whether tickets are on sale. |
session
-
Boolean!
|
Whether a session has been added. |
ticketType
-
Boolean!
|
Whether a ticket type has been added. |
url -
Boolean!
|
Whether the URL has been updated. |
venue
-
Boolean!
|
Whether a venue has been added. |
Example
{
"event": true,
"eventId": "xyz789",
"gateway": "CONNECTED",
"onsale": true,
"session": true,
"ticketType": false,
"url": false,
"venue": true
}
Order
Description
An order represents a completed transaction.
Fields
| Field Name | Description |
|---|---|
acceptsMarketing
-
Boolean!
|
Whether the customer has consented to future marketing communications. |
bookingFees
-
Money!
|
The current booking fees. |
cardExpMonth
-
Float
|
The original payment card expiry month. |
cardExpYear
-
Float
|
The original payment card expiry year. |
cardLast4
-
Float
|
The original payment card last 4 digits. |
cardNetwork
-
String
|
The original payment card network. |
email
-
String!
|
The email address of the customer. |
firstName
-
String!
|
The first name of the customer. |
id -
ID!
|
A unique identifier. |
lastName
-
String!
|
The last name of the customer. |
originalBookingFees
-
Money!
|
The original booking fees. |
originalPaymentFees
-
Money!
|
The original payment processing fees. |
originalSubtotal
-
Money!
|
The original subtotal amount before fees and discounts. |
originalTotal
-
Money!
|
The original total paid for the order. |
paymentFees
-
Money!
|
The current payment processing fees. |
paymentIntentId
-
String
|
The payment gateway's transaction reference for the order. |
paymentStatus
-
OrderPaymentStatus!
|
The payment status of the order. |
phone
-
String!
|
The phone number of the customer. |
processed
-
DateTime!
|
When the order was created or imported. |
publicId
-
String!
|
A unique alphanumeric identifier for the order. Can be shared with customers to identify their orders. |
subtotal
-
Money!
|
The current subtotal amount before fees and discounts. |
tickets
-
[Ticket!]!
|
|
Arguments
|
|
ticketsAggregate
-
[OrderTicketsAggregateResponse!]!
|
|
Arguments
|
|
total
-
Money!
|
The current total paid for the order. |
Example
{
"acceptsMarketing": false,
"bookingFees": "123.45",
"cardExpMonth": 987.65,
"cardExpYear": 123.45,
"cardLast4": 987.65,
"cardNetwork": "xyz789",
"email": "abc123",
"firstName": "xyz789",
"id": "4",
"lastName": "xyz789",
"originalBookingFees": "123.45",
"originalPaymentFees": "123.45",
"originalSubtotal": "123.45",
"originalTotal": "123.45",
"paymentFees": "123.45",
"paymentIntentId": "abc123",
"paymentStatus": "PAID",
"phone": "xyz789",
"processed": "2023-01-01T00:00:00.000Z",
"publicId": "xyz789",
"subtotal": "123.45",
"tickets": [Ticket],
"ticketsAggregate": [OrderTicketsAggregateResponse],
"total": "123.45"
}
OrderConnection
Fields
| Field Name | Description |
|---|---|
edges
-
[OrderEdge!]!
|
Array of edges. |
pageInfo
-
PageInfo!
|
Paging information |
Example
{
"edges": [OrderEdge],
"pageInfo": PageInfo
}
OrderEdge
Fields
| Field Name | Description |
|---|---|
cursor
-
ConnectionCursor!
|
Cursor for this node. |
node -
Order!
|
The node containing the Order |
Example
{
"cursor": ConnectionCursor,
"node": Order
}
OrderFilter
Fields
| Input Field | Description |
|---|---|
and -
[OrderFilter!]
|
|
id -
IDFilterComparison
|
|
or -
[OrderFilter!]
|
|
paymentIntentId
-
StringFieldComparison
|
|
processed
-
DateFieldComparison
|
|
tickets
-
OrderFilterTicketFilter
|
Example
{
"and": [OrderFilter],
"id": IDFilterComparison,
"or": [OrderFilter],
"paymentIntentId": StringFieldComparison,
"processed": DateFieldComparison,
"tickets": OrderFilterTicketFilter
}
OrderFilterTicketFilter
Fields
| Input Field | Description |
|---|---|
and -
[OrderFilterTicketFilter!]
|
|
id -
IDFilterComparison
|
|
or -
[OrderFilterTicketFilter!]
|
|
sessionId
-
IDFilterComparison
|
|
status
-
TicketStatusFilterComparison
|
Example
{
"and": [OrderFilterTicketFilter],
"id": IDFilterComparison,
"or": [OrderFilterTicketFilter],
"sessionId": IDFilterComparison,
"status": TicketStatusFilterComparison
}
OrderPaymentStatus
Description
The current payment status of an order.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PAID"
OrderSort
Fields
| Input Field | Description |
|---|---|
direction
-
SortDirection!
|
|
field
-
OrderSortFields!
|
|
nulls
-
SortNulls
|
Example
{"direction": "ASC", "field": "id", "nulls": "NULLS_FIRST"}
OrderSortFields
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"id"
OrderTicketsAggregateGroupBy
Fields
| Field Name | Description |
|---|---|
id -
ID
|
|
sessionId
-
ID
|
|
status
-
TicketStatus
|
Example
{
"id": "4",
"sessionId": 4,
"status": "REFUNDED"
}
OrderTicketsAggregateResponse
Fields
| Field Name | Description |
|---|---|
count
-
OrderTicketsCountAggregate
|
|
groupBy
-
OrderTicketsAggregateGroupBy
|
|
max -
OrderTicketsMaxAggregate
|
|
min -
OrderTicketsMinAggregate
|
Example
{
"count": OrderTicketsCountAggregate,
"groupBy": OrderTicketsAggregateGroupBy,
"max": OrderTicketsMaxAggregate,
"min": OrderTicketsMinAggregate
}
OrderTicketsCountAggregate
OrderTicketsMaxAggregate
Fields
| Field Name | Description |
|---|---|
id -
ID
|
|
sessionId
-
ID
|
|
status
-
TicketStatus
|
Example
{
"id": 4,
"sessionId": "4",
"status": "REFUNDED"
}
OrderTicketsMinAggregate
Fields
| Field Name | Description |
|---|---|
id -
ID
|
|
sessionId
-
ID
|
|
status
-
TicketStatus
|
Example
{
"id": "4",
"sessionId": 4,
"status": "REFUNDED"
}
PageInfo
Fields
| Field Name | Description |
|---|---|
endCursor
-
ConnectionCursor
|
The cursor of the last returned record. |
hasNextPage
-
Boolean
|
true if paging forward and there are more records. |
hasPreviousPage
-
Boolean
|
true if paging backwards and there are more records. |
startCursor
-
ConnectionCursor
|
The cursor of the first returned record. |
Example
{
"endCursor": ConnectionCursor,
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": ConnectionCursor
}
PaymentGateway
Description
Represents an external payment gateway account and associated payment processing fee amounts.
Fields
| Field Name | Description |
|---|---|
created
-
DateTime
|
When the record was created. |
feeFixed
-
Money!
|
The standard price of the ticket type. |
feeMatch
-
Boolean!
|
Whether the payment processing fee should be set to match the processing charge through the external gateway. |
feePercent
-
Float!
|
Payment processing fee percentage value to add to transactions through this gateway. Applied only if feeMatch is not set. |
provider
-
PaymentGatewayProvider!
|
The gateway account provider. |
updated
-
DateTime
|
When the record was last updated. |
Example
{
"created": "2023-01-01T00:00:00.000Z",
"feeFixed": "123.45",
"feeMatch": true,
"feePercent": 123.45,
"provider": "BRAINTREE",
"updated": "2023-01-01T00:00:00.000Z"
}
PaymentGatewayInput
PaymentGatewayProvider
Description
The payment gateway vendor.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"BRAINTREE"
PaymentGatewayStatus
Description
Potential statuses of a payment gateway.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CONNECTED"
RemoveSessionTicketTypesFromSessionInput
RemoveSessionTicketTypesFromTicketTypeInput
ReorderInput
Fields
| Input Field | Description |
|---|---|
ids -
[ID!]!
|
Example
{"ids": [4]}
Session
Description
A session represents the date, time & location of a session, show, or performance of an event.
Fields
| Field Name | Description |
|---|---|
capacity
-
Int
|
The maximum capacity of the session. |
countIssued
-
Int!
|
The number of tickets issued for this session. |
countPending
-
Int!
|
The number of pending tickets for this session. |
created
-
DateTime
|
When the session was created. |
doors
-
DateTime
|
The door opening date and time of the session in UTC. |
end -
DateTime
|
The end date and time of the session in UTC. |
event
-
Event!
|
|
eventId
-
String!
|
The ID of the event the session belongs to. |
id -
ID!
|
The ID of the session. |
offsale
-
DateTime
|
The offsale date and time of the session in UTC. |
onsale
-
DateTime
|
The onsale date and time of the session in UTC. |
sales
-
Money!
|
The sum of ticket sales (price + booking fees) for this session. |
sessionTicketTypes
-
[SessionTicketType!]!
|
|
Arguments
|
|
start
-
DateTime!
|
The start date and time of the session in UTC. |
updated
-
DateTime
|
When the session was last updated. |
venue
-
Venue!
|
|
Example
{
"capacity": 123,
"countIssued": 123,
"countPending": 987,
"created": "2023-01-01T00:00:00.000Z",
"doors": "2023-01-01T00:00:00.000Z",
"end": "2023-01-01T00:00:00.000Z",
"event": Event,
"eventId": "abc123",
"id": "4",
"offsale": "2023-01-01T00:00:00.000Z",
"onsale": "2023-01-01T00:00:00.000Z",
"sales": "123.45",
"sessionTicketTypes": [SessionTicketType],
"start": "2023-01-01T00:00:00.000Z",
"updated": "2023-01-01T00:00:00.000Z",
"venue": Venue
}
SessionConnection
Fields
| Field Name | Description |
|---|---|
edges
-
[SessionEdge!]!
|
Array of edges. |
pageInfo
-
PageInfo!
|
Paging information |
Example
{
"edges": [SessionEdge],
"pageInfo": PageInfo
}
SessionDeleteFilter
Fields
| Input Field | Description |
|---|---|
and -
[SessionDeleteFilter!]
|
|
eventId
-
IDFilterComparison
|
|
or -
[SessionDeleteFilter!]
|
|
start
-
DateFieldComparison
|
Example
{
"and": [SessionDeleteFilter],
"eventId": IDFilterComparison,
"or": [SessionDeleteFilter],
"start": DateFieldComparison
}
SessionDeleteResponse
Fields
| Field Name | Description |
|---|---|
capacity
-
Int
|
The maximum capacity of the session. |
created
-
DateTime
|
When the session was created. |
doors
-
DateTime
|
The door opening date and time of the session in UTC. |
end -
DateTime
|
The end date and time of the session in UTC. |
eventId
-
String
|
The ID of the event the session belongs to. |
id -
ID
|
The ID of the session. |
offsale
-
DateTime
|
The offsale date and time of the session in UTC. |
onsale
-
DateTime
|
The onsale date and time of the session in UTC. |
start
-
DateTime
|
The start date and time of the session in UTC. |
updated
-
DateTime
|
When the session was last updated. |
Example
{
"capacity": 123,
"created": "2023-01-01T00:00:00.000Z",
"doors": "2023-01-01T00:00:00.000Z",
"end": "2023-01-01T00:00:00.000Z",
"eventId": "xyz789",
"id": 4,
"offsale": "2023-01-01T00:00:00.000Z",
"onsale": "2023-01-01T00:00:00.000Z",
"start": "2023-01-01T00:00:00.000Z",
"updated": "2023-01-01T00:00:00.000Z"
}
SessionEdge
Fields
| Field Name | Description |
|---|---|
cursor
-
ConnectionCursor!
|
Cursor for this node. |
node -
Session!
|
The node containing the Session |
Example
{
"cursor": ConnectionCursor,
"node": Session
}
SessionFilter
Fields
| Input Field | Description |
|---|---|
and -
[SessionFilter!]
|
|
eventId
-
IDFilterComparison
|
|
or -
[SessionFilter!]
|
|
sessionTicketTypes
-
SessionFilterSessionTicketTypeFilter
|
|
start
-
DateFieldComparison
|
Example
{
"and": [SessionFilter],
"eventId": IDFilterComparison,
"or": [SessionFilter],
"sessionTicketTypes": SessionFilterSessionTicketTypeFilter,
"start": DateFieldComparison
}
SessionFilterSessionTicketTypeFilter
Fields
| Input Field | Description |
|---|---|
and -
[SessionFilterSessionTicketTypeFilter!]
|
|
enabled
-
BooleanFieldComparison
|
|
or -
[SessionFilterSessionTicketTypeFilter!]
|
|
sessionId
-
IDFilterComparison
|
|
ticketTypeId
-
IDFilterComparison
|
Example
{
"and": [SessionFilterSessionTicketTypeFilter],
"enabled": BooleanFieldComparison,
"or": [SessionFilterSessionTicketTypeFilter],
"sessionId": IDFilterComparison,
"ticketTypeId": IDFilterComparison
}
SessionSort
Fields
| Input Field | Description |
|---|---|
direction
-
SortDirection!
|
|
field
-
SessionSortFields!
|
|
nulls
-
SortNulls
|
Example
{"direction": "ASC", "field": "eventId", "nulls": "NULLS_FIRST"}
SessionSortFields
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"eventId"
SessionTicketType
Description
The session's ticket type association.
Fields
| Field Name | Description |
|---|---|
bookingFee
-
Money
|
The standard price of the ticket type. |
capacity
-
Int
|
The maximum number of the ticket type for the session. |
countIssued
-
Int!
|
The number of tickets issued for this session ticket type. |
countPending
-
Int!
|
The number of pending tickets for this session ticket type. |
enabled
-
Boolean!
|
Whether the ticket type is currently enabled for the session. |
price
-
Money
|
The price of the ticket type for the session. |
sales
-
Money!
|
The sum of ticket sales (price + booking fees) for this session ticket type. |
session
-
Session!
|
|
sessionId
-
ID!
|
The session ID. |
ticketType
-
TicketType!
|
|
ticketTypeId
-
ID!
|
The ticket type ID. |
Example
{
"bookingFee": "123.45",
"capacity": 987,
"countIssued": 987,
"countPending": 123,
"enabled": true,
"price": "123.45",
"sales": "123.45",
"session": Session,
"sessionId": "4",
"ticketType": TicketType,
"ticketTypeId": 4
}
SessionTicketTypeConnection
Fields
| Field Name | Description |
|---|---|
edges
-
[SessionTicketTypeEdge!]!
|
Array of edges. |
pageInfo
-
PageInfo!
|
Paging information |
Example
{
"edges": [SessionTicketTypeEdge],
"pageInfo": PageInfo
}
SessionTicketTypeDeleteFilter
Fields
| Input Field | Description |
|---|---|
and -
[SessionTicketTypeDeleteFilter!]
|
|
enabled
-
BooleanFieldComparison
|
|
or -
[SessionTicketTypeDeleteFilter!]
|
|
sessionId
-
IDFilterComparison
|
|
ticketTypeId
-
IDFilterComparison
|
Example
{
"and": [SessionTicketTypeDeleteFilter],
"enabled": BooleanFieldComparison,
"or": [SessionTicketTypeDeleteFilter],
"sessionId": IDFilterComparison,
"ticketTypeId": IDFilterComparison
}
SessionTicketTypeDeleteResponse
Fields
| Field Name | Description |
|---|---|
bookingFee
-
Money
|
The standard price of the ticket type. |
capacity
-
Int
|
The maximum number of the ticket type for the session. |
enabled
-
Boolean
|
Whether the ticket type is currently enabled for the session. |
price
-
Money
|
The price of the ticket type for the session. |
sessionId
-
ID
|
The session ID. |
ticketTypeId
-
ID
|
The ticket type ID. |
Example
{
"bookingFee": "123.45",
"capacity": 987,
"enabled": false,
"price": "123.45",
"sessionId": "4",
"ticketTypeId": 4
}
SessionTicketTypeEdge
Fields
| Field Name | Description |
|---|---|
cursor
-
ConnectionCursor!
|
Cursor for this node. |
node -
SessionTicketType!
|
The node containing the SessionTicketType |
Example
{
"cursor": ConnectionCursor,
"node": SessionTicketType
}
SessionTicketTypeFilter
Fields
| Input Field | Description |
|---|---|
and -
[SessionTicketTypeFilter!]
|
|
enabled
-
BooleanFieldComparison
|
|
or -
[SessionTicketTypeFilter!]
|
|
sessionId
-
IDFilterComparison
|
|
ticketTypeId
-
IDFilterComparison
|
Example
{
"and": [SessionTicketTypeFilter],
"enabled": BooleanFieldComparison,
"or": [SessionTicketTypeFilter],
"sessionId": IDFilterComparison,
"ticketTypeId": IDFilterComparison
}
SessionTicketTypeInput
Description
The inputs for a session's ticket type.
Fields
| Input Field | Description |
|---|---|
bookingFee
-
Money
|
|
capacity
-
Int
|
The session's maximum number of the ticket type. |
enabled
-
Boolean
|
Whether the ticket type is currently enabled for the session. |
price
-
Money
|
|
sessionId
-
String!
|
The ID of the session. |
ticketTypeId
-
String!
|
The ID of the ticket type. |
Example
{
"bookingFee": "123.45",
"capacity": 987,
"enabled": true,
"price": "123.45",
"sessionId": "abc123",
"ticketTypeId": "abc123"
}
SessionTicketTypeSort
Fields
| Input Field | Description |
|---|---|
direction
-
SortDirection!
|
|
field
-
SessionTicketTypeSortFields!
|
|
nulls
-
SortNulls
|
Example
{"direction": "ASC", "field": "enabled", "nulls": "NULLS_FIRST"}
SessionTicketTypeSortFields
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"enabled"
SessionTicketTypeUpdateFilter
Fields
| Input Field | Description |
|---|---|
and -
[SessionTicketTypeUpdateFilter!]
|
|
enabled
-
BooleanFieldComparison
|
|
or -
[SessionTicketTypeUpdateFilter!]
|
|
sessionId
-
IDFilterComparison
|
|
ticketTypeId
-
IDFilterComparison
|
Example
{
"and": [SessionTicketTypeUpdateFilter],
"enabled": BooleanFieldComparison,
"or": [SessionTicketTypeUpdateFilter],
"sessionId": IDFilterComparison,
"ticketTypeId": IDFilterComparison
}
SessionUpdateFilter
Fields
| Input Field | Description |
|---|---|
and -
[SessionUpdateFilter!]
|
|
eventId
-
IDFilterComparison
|
|
or -
[SessionUpdateFilter!]
|
|
start
-
DateFieldComparison
|
Example
{
"and": [SessionUpdateFilter],
"eventId": IDFilterComparison,
"or": [SessionUpdateFilter],
"start": DateFieldComparison
}
SetSessionTicketTypesOnSessionInput
SetSessionTicketTypesOnTicketTypeInput
SortDirection
Description
Sort Directions
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ASC"
SortNulls
Description
Sort Nulls Options
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"NULLS_FIRST"
String
Description
The String scalar type represents textual data,
represented as UTF-8 character sequences. The String type is
most often used by GraphQL to represent free-form
human-readable text.
Example
"abc123"
StringFieldComparison
Example
{
"eq": "xyz789",
"gt": "xyz789",
"gte": "abc123",
"iLike": "abc123",
"in": ["abc123"],
"is": false,
"isNot": true,
"like": "abc123",
"lt": "xyz789",
"lte": "xyz789",
"neq": "xyz789",
"notILike": "abc123",
"notIn": ["abc123"],
"notLike": "abc123"
}
Ticket
Description
The record representing a ticket.
Fields
| Field Name | Description |
|---|---|
bookingFee
-
Money!
|
The booking fee paid for this ticket. |
id -
ID!
|
A unique identifier. |
number
-
Int!
|
A sequential numeric identifier for this ticket within the order. |
order
-
Order!
|
|
price
-
Money!
|
The face value paid for this ticket. |
sessionId
-
String!
|
The session ID this ticket is for. |
sessionTicketType
-
SessionTicketType!
|
|
status
-
TicketStatus!
|
The current status of the ticket. |
Example
{
"bookingFee": "123.45",
"id": 4,
"number": 123,
"order": Order,
"price": "123.45",
"sessionId": "abc123",
"sessionTicketType": SessionTicketType,
"status": "REFUNDED"
}
TicketAggregateFilter
Fields
| Input Field | Description |
|---|---|
and -
[TicketAggregateFilter!]
|
|
id -
IDFilterComparison
|
|
or -
[TicketAggregateFilter!]
|
|
sessionId
-
IDFilterComparison
|
|
status
-
TicketStatusFilterComparison
|
Example
{
"and": [TicketAggregateFilter],
"id": IDFilterComparison,
"or": [TicketAggregateFilter],
"sessionId": IDFilterComparison,
"status": TicketStatusFilterComparison
}
TicketFilter
Fields
| Input Field | Description |
|---|---|
and -
[TicketFilter!]
|
|
id -
IDFilterComparison
|
|
or -
[TicketFilter!]
|
|
sessionId
-
IDFilterComparison
|
|
status
-
TicketStatusFilterComparison
|
Example
{
"and": [TicketFilter],
"id": IDFilterComparison,
"or": [TicketFilter],
"sessionId": IDFilterComparison,
"status": TicketStatusFilterComparison
}
TicketSort
Fields
| Input Field | Description |
|---|---|
direction
-
SortDirection!
|
|
field
-
TicketSortFields!
|
|
nulls
-
SortNulls
|
Example
{"direction": "ASC", "field": "id", "nulls": "NULLS_FIRST"}
TicketSortFields
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"id"
TicketStatus
Description
The current status of a ticket.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"REFUNDED"
TicketStatusFilterComparison
Fields
| Input Field | Description |
|---|---|
eq -
TicketStatus
|
|
gt -
TicketStatus
|
|
gte -
TicketStatus
|
|
iLike
-
TicketStatus
|
|
in -
[TicketStatus!]
|
|
is -
Boolean
|
|
isNot
-
Boolean
|
|
like -
TicketStatus
|
|
lt -
TicketStatus
|
|
lte -
TicketStatus
|
|
neq -
TicketStatus
|
|
notILike
-
TicketStatus
|
|
notIn
-
[TicketStatus!]
|
|
notLike
-
TicketStatus
|
Example
{
"eq": "REFUNDED",
"gt": "REFUNDED",
"gte": "REFUNDED",
"iLike": "REFUNDED",
"in": ["REFUNDED"],
"is": true,
"isNot": false,
"like": "REFUNDED",
"lt": "REFUNDED",
"lte": "REFUNDED",
"neq": "REFUNDED",
"notILike": "REFUNDED",
"notIn": ["REFUNDED"],
"notLike": "REFUNDED"
}
TicketType
Description
Ticket type
Fields
| Field Name | Description |
|---|---|
bookingFee
-
Money!
|
The standard price of the ticket type. |
created
-
DateTime
|
When the ticket type was created. |
id -
ID!
|
The ID of the ticket type. |
name -
String!
|
The name of the ticket type. |
price
-
Money!
|
The standard price of the ticket type. |
sessionTicketTypes
-
[SessionTicketType!]
|
|
Arguments
|
|
sort -
Int
|
The sort rank of the ticket type. |
updated
-
DateTime
|
When the ticket type was last updated. |
Example
{
"bookingFee": "123.45",
"created": "2023-01-01T00:00:00.000Z",
"id": "4",
"name": "abc123",
"price": "123.45",
"sessionTicketTypes": [SessionTicketType],
"sort": 123,
"updated": "2023-01-01T00:00:00.000Z"
}
TicketTypeConnection
Fields
| Field Name | Description |
|---|---|
edges
-
[TicketTypeEdge!]!
|
Array of edges. |
pageInfo
-
PageInfo!
|
Paging information |
Example
{
"edges": [TicketTypeEdge],
"pageInfo": PageInfo
}
TicketTypeDeleteFilter
Fields
| Input Field | Description |
|---|---|
and -
[TicketTypeDeleteFilter!]
|
|
id -
IDFilterComparison
|
|
name -
StringFieldComparison
|
|
or -
[TicketTypeDeleteFilter!]
|
|
sort -
IntFieldComparison
|
Example
{
"and": [TicketTypeDeleteFilter],
"id": IDFilterComparison,
"name": StringFieldComparison,
"or": [TicketTypeDeleteFilter],
"sort": IntFieldComparison
}
TicketTypeDeleteResponse
Fields
| Field Name | Description |
|---|---|
bookingFee
-
Money
|
The standard price of the ticket type. |
created
-
DateTime
|
When the ticket type was created. |
id -
ID
|
The ID of the ticket type. |
name -
String
|
The name of the ticket type. |
price
-
Money
|
The standard price of the ticket type. |
sessionTicketTypes
-
[SessionTicketType!]
|
The session relations for the ticket type. |
sort -
Int
|
The sort rank of the ticket type. |
updated
-
DateTime
|
When the ticket type was last updated. |
Example
{
"bookingFee": "123.45",
"created": "2023-01-01T00:00:00.000Z",
"id": "4",
"name": "abc123",
"price": "123.45",
"sessionTicketTypes": [SessionTicketType],
"sort": 987,
"updated": "2023-01-01T00:00:00.000Z"
}
TicketTypeEdge
Fields
| Field Name | Description |
|---|---|
cursor
-
ConnectionCursor!
|
Cursor for this node. |
node -
TicketType!
|
The node containing the TicketType |
Example
{
"cursor": ConnectionCursor,
"node": TicketType
}
TicketTypeFilter
Fields
| Input Field | Description |
|---|---|
and -
[TicketTypeFilter!]
|
|
id -
IDFilterComparison
|
|
name -
StringFieldComparison
|
|
or -
[TicketTypeFilter!]
|
|
sort -
IntFieldComparison
|
Example
{
"and": [TicketTypeFilter],
"id": IDFilterComparison,
"name": StringFieldComparison,
"or": [TicketTypeFilter],
"sort": IntFieldComparison
}
TicketTypeInput
TicketTypeSort
Fields
| Input Field | Description |
|---|---|
direction
-
SortDirection!
|
|
field
-
TicketTypeSortFields!
|
|
nulls
-
SortNulls
|
Example
{"direction": "ASC", "field": "id", "nulls": "NULLS_FIRST"}
TicketTypeSortFields
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"id"
TicketTypeUpdateFilter
Fields
| Input Field | Description |
|---|---|
and -
[TicketTypeUpdateFilter!]
|
|
id -
IDFilterComparison
|
|
name -
StringFieldComparison
|
|
or -
[TicketTypeUpdateFilter!]
|
|
sort -
IntFieldComparison
|
Example
{
"and": [TicketTypeUpdateFilter],
"id": IDFilterComparison,
"name": StringFieldComparison,
"or": [TicketTypeUpdateFilter],
"sort": IntFieldComparison
}
UpdateManyEventsInput
Fields
| Input Field | Description |
|---|---|
filter
-
EventUpdateFilter!
|
Filter used to find fields to update |
update
-
EventInput!
|
The update to apply to all records found using the filter |
Example
{
"filter": EventUpdateFilter,
"update": EventInput
}
UpdateManyResponse
Fields
| Field Name | Description |
|---|---|
updatedCount
-
Int!
|
The number of records updated. |
Example
{"updatedCount": 123}
UpdateManySessionTicketTypesInput
Fields
| Input Field | Description |
|---|---|
filter
-
SessionTicketTypeUpdateFilter!
|
Filter used to find fields to update |
update
-
SessionTicketTypeInput!
|
The update to apply to all records found using the filter |
Example
{
"filter": SessionTicketTypeUpdateFilter,
"update": SessionTicketTypeInput
}
UpdateManySessionsInput
Fields
| Input Field | Description |
|---|---|
filter
-
SessionUpdateFilter!
|
Filter used to find fields to update |
update
-
UpdateSessionInput!
|
The update to apply to all records found using the filter |
Example
{
"filter": SessionUpdateFilter,
"update": UpdateSessionInput
}
UpdateManyTicketTypesInput
Fields
| Input Field | Description |
|---|---|
filter
-
TicketTypeUpdateFilter!
|
Filter used to find fields to update |
update
-
TicketTypeInput!
|
The update to apply to all records found using the filter |
Example
{
"filter": TicketTypeUpdateFilter,
"update": TicketTypeInput
}
UpdateManyUsersInput
Fields
| Input Field | Description |
|---|---|
filter
-
UserUpdateFilter!
|
Filter used to find fields to update |
update
-
UserInput!
|
The update to apply to all records found using the filter |
Example
{
"filter": UserUpdateFilter,
"update": UserInput
}
UpdateManyVenuesInput
Fields
| Input Field | Description |
|---|---|
filter
-
VenueUpdateFilter!
|
Filter used to find fields to update |
update
-
VenueInput!
|
The update to apply to all records found using the filter |
Example
{
"filter": VenueUpdateFilter,
"update": VenueInput
}
UpdateOneEventInput
Fields
| Input Field | Description |
|---|---|
id -
ID!
|
The id of the record to update |
update
-
EventInput!
|
The update to apply. |
Example
{"id": 4, "update": EventInput}
UpdateOneSessionInput
Fields
| Input Field | Description |
|---|---|
id -
ID!
|
The id of the record to update |
update
-
UpdateSessionInput!
|
The update to apply. |
Example
{"id": 4, "update": UpdateSessionInput}
UpdateOneSessionTicketTypeInput
Fields
| Input Field | Description |
|---|---|
id -
ID!
|
The id of the record to update |
update
-
SessionTicketTypeInput!
|
The update to apply. |
Example
{"id": 4, "update": SessionTicketTypeInput}
UpdateOneTicketTypeInput
Fields
| Input Field | Description |
|---|---|
id -
ID!
|
The id of the record to update |
update
-
TicketTypeInput!
|
The update to apply. |
Example
{"id": 4, "update": TicketTypeInput}
UpdateOneUserInput
Fields
| Input Field | Description |
|---|---|
id -
ID!
|
The id of the record to update |
update
-
UserInput!
|
The update to apply. |
Example
{
"id": "4",
"update": UserInput
}
UpdateOneVenueInput
Fields
| Input Field | Description |
|---|---|
id -
ID!
|
The id of the record to update |
update
-
VenueInput!
|
The update to apply. |
Example
{
"id": "4",
"update": VenueInput
}
UpdateSessionInput
Description
The inputs for an updateSession mutation.
Fields
| Input Field | Description |
|---|---|
capacity
-
Int
|
The maximum capacity of the session. |
doors
-
DateTime
|
The door opening date and time of the session. |
end -
DateTime
|
The local end date and time of the session. |
offsale
-
DateTime
|
The offsale date and time of the session. |
onsale
-
DateTime
|
The onsale date and time of the session. |
start
-
DateTime
|
The local start date and time of the session. |
venueId
-
ID
|
The ID of the venue the session takes place at. |
Example
{
"capacity": 123,
"doors": "2023-01-01T00:00:00.000Z",
"end": "2023-01-01T00:00:00.000Z",
"offsale": "2023-01-01T00:00:00.000Z",
"onsale": "2023-01-01T00:00:00.000Z",
"start": "2023-01-01T00:00:00.000Z",
"venueId": 4
}
User
Description
Represents a user under your organisation's account.
Fields
| Field Name | Description |
|---|---|
created
-
DateTime
|
When the user was created. |
email
-
String!
|
The user's email address. |
firstName
-
String
|
The user's first name. |
id -
ID
|
The ID of the user. |
lastLogin
-
DateTime
|
When the user last logged in. |
lastName
-
String
|
The user's last name. |
updated
-
DateTime
|
When the user was last updated. |
Example
{
"created": "2023-01-01T00:00:00.000Z",
"email": "xyz789",
"firstName": "abc123",
"id": 4,
"lastLogin": "2023-01-01T00:00:00.000Z",
"lastName": "xyz789",
"updated": "2023-01-01T00:00:00.000Z"
}
UserConnection
Fields
| Field Name | Description |
|---|---|
edges
-
[UserEdge!]!
|
Array of edges. |
pageInfo
-
PageInfo!
|
Paging information |
Example
{
"edges": [UserEdge],
"pageInfo": PageInfo
}
UserDeleteFilter
Fields
| Input Field | Description |
|---|---|
and -
[UserDeleteFilter!]
|
|
id -
IDFilterComparison
|
|
or -
[UserDeleteFilter!]
|
Example
{
"and": [UserDeleteFilter],
"id": IDFilterComparison,
"or": [UserDeleteFilter]
}
UserDeleteResponse
Fields
| Field Name | Description |
|---|---|
created
-
DateTime
|
When the user was created. |
email
-
String
|
The user's email address. |
firstName
-
String
|
The user's first name. |
id -
ID
|
The ID of the user. |
lastLogin
-
DateTime
|
When the user last logged in. |
lastName
-
String
|
The user's last name. |
updated
-
DateTime
|
When the user was last updated. |
Example
{
"created": "2023-01-01T00:00:00.000Z",
"email": "xyz789",
"firstName": "xyz789",
"id": "4",
"lastLogin": "2023-01-01T00:00:00.000Z",
"lastName": "abc123",
"updated": "2023-01-01T00:00:00.000Z"
}
UserEdge
Fields
| Field Name | Description |
|---|---|
cursor
-
ConnectionCursor!
|
Cursor for this node. |
node -
User!
|
The node containing the User |
Example
{
"cursor": ConnectionCursor,
"node": User
}
UserFilter
Fields
| Input Field | Description |
|---|---|
and -
[UserFilter!]
|
|
id -
IDFilterComparison
|
|
or -
[UserFilter!]
|
Example
{
"and": [UserFilter],
"id": IDFilterComparison,
"or": [UserFilter]
}
UserInput
UserSort
Fields
| Input Field | Description |
|---|---|
direction
-
SortDirection!
|
|
field
-
UserSortFields!
|
|
nulls
-
SortNulls
|
Example
{"direction": "ASC", "field": "id", "nulls": "NULLS_FIRST"}
UserSortFields
Values
| Enum Value | Description |
|---|---|
|
|
Example
"id"
UserUpdateFilter
Fields
| Input Field | Description |
|---|---|
and -
[UserUpdateFilter!]
|
|
id -
IDFilterComparison
|
|
or -
[UserUpdateFilter!]
|
Example
{
"and": [UserUpdateFilter],
"id": IDFilterComparison,
"or": [UserUpdateFilter]
}
Venue
Description
A venue is the location a session will take place at.
Fields
| Field Name | Description |
|---|---|
address
-
String
|
The street address of the venue. |
capacity
-
Int
|
The maximum capacity of the venue. |
city -
String!
|
The venue's city. |
country
-
String!
|
The venue's country. |
created
-
DateTime
|
When the venue was created. |
id -
ID!
|
The ID of the venue. |
latLong
-
String
|
The latitude and longitude of the venue. |
name -
String!
|
The name of the venue. |
postalCode
-
String
|
The venue's zip or postcode. |
sessions
-
[Session!]!
|
Sessions taking place at the venue. |
space
-
String
|
The room, hall or building within the venue. |
state
-
String
|
The venue's state. |
suburb
-
String
|
The suburb of the venue. |
timezone
-
String!
|
The timezone of the venue. |
updated
-
DateTime
|
When the venue was last updated. |
Example
{
"address": "xyz789",
"capacity": 987,
"city": "abc123",
"country": "abc123",
"created": "2023-01-01T00:00:00.000Z",
"id": "4",
"latLong": "abc123",
"name": "xyz789",
"postalCode": "xyz789",
"sessions": [Session],
"space": "xyz789",
"state": "xyz789",
"suburb": "abc123",
"timezone": "xyz789",
"updated": "2023-01-01T00:00:00.000Z"
}
VenueConnection
Fields
| Field Name | Description |
|---|---|
edges
-
[VenueEdge!]!
|
Array of edges. |
pageInfo
-
PageInfo!
|
Paging information |
Example
{
"edges": [VenueEdge],
"pageInfo": PageInfo
}
VenueDeleteFilter
Fields
| Input Field | Description |
|---|---|
and -
[VenueDeleteFilter!]
|
|
city -
StringFieldComparison
|
|
country
-
StringFieldComparison
|
|
id -
IDFilterComparison
|
|
name -
StringFieldComparison
|
|
or -
[VenueDeleteFilter!]
|
|
space
-
StringFieldComparison
|
Example
{
"and": [VenueDeleteFilter],
"city": StringFieldComparison,
"country": StringFieldComparison,
"id": IDFilterComparison,
"name": StringFieldComparison,
"or": [VenueDeleteFilter],
"space": StringFieldComparison
}
VenueDeleteResponse
Fields
| Field Name | Description |
|---|---|
address
-
String
|
The street address of the venue. |
capacity
-
Int
|
The maximum capacity of the venue. |
city -
String
|
The venue's city. |
country
-
String
|
The venue's country. |
created
-
DateTime
|
When the venue was created. |
id -
ID
|
The ID of the venue. |
latLong
-
String
|
The latitude and longitude of the venue. |
name -
String
|
The name of the venue. |
postalCode
-
String
|
The venue's zip or postcode. |
sessions
-
[Session!]
|
Sessions taking place at the venue. |
space
-
String
|
The room, hall or building within the venue. |
state
-
String
|
The venue's state. |
suburb
-
String
|
The suburb of the venue. |
timezone
-
String
|
The timezone of the venue. |
updated
-
DateTime
|
When the venue was last updated. |
Example
{
"address": "xyz789",
"capacity": 987,
"city": "xyz789",
"country": "abc123",
"created": "2023-01-01T00:00:00.000Z",
"id": 4,
"latLong": "xyz789",
"name": "xyz789",
"postalCode": "abc123",
"sessions": [Session],
"space": "abc123",
"state": "xyz789",
"suburb": "xyz789",
"timezone": "abc123",
"updated": "2023-01-01T00:00:00.000Z"
}
VenueEdge
Fields
| Field Name | Description |
|---|---|
cursor
-
ConnectionCursor!
|
Cursor for this node. |
node -
Venue!
|
The node containing the Venue |
Example
{
"cursor": ConnectionCursor,
"node": Venue
}
VenueFilter
Fields
| Input Field | Description |
|---|---|
and -
[VenueFilter!]
|
|
city -
StringFieldComparison
|
|
country
-
StringFieldComparison
|
|
id -
IDFilterComparison
|
|
name -
StringFieldComparison
|
|
or -
[VenueFilter!]
|
|
space
-
StringFieldComparison
|
Example
{
"and": [VenueFilter],
"city": StringFieldComparison,
"country": StringFieldComparison,
"id": IDFilterComparison,
"name": StringFieldComparison,
"or": [VenueFilter],
"space": StringFieldComparison
}
VenueInput
Fields
| Input Field | Description |
|---|---|
address
-
String
|
The street address of the venue. |
capacity
-
Int
|
The maximum capacity of the venue. |
city -
String!
|
The venue's city. |
country
-
String!
|
The venue's country. |
latLong
-
String
|
The latitude and longitude of the venue. |
name -
String!
|
The name of the venue. |
postalCode
-
String
|
The venue's zip or postcode. |
space
-
String
|
The room, hall or building within the venue. |
state
-
String
|
The venue's state. |
suburb
-
String
|
The suburb of the venue. |
timezone
-
String!
|
The timezone of the venue. |
Example
{
"address": "abc123",
"capacity": 987,
"city": "abc123",
"country": "abc123",
"latLong": "abc123",
"name": "abc123",
"postalCode": "xyz789",
"space": "xyz789",
"state": "xyz789",
"suburb": "abc123",
"timezone": "abc123"
}
VenueSort
Fields
| Input Field | Description |
|---|---|
direction
-
SortDirection!
|
|
field
-
VenueSortFields!
|
|
nulls
-
SortNulls
|
Example
{"direction": "ASC", "field": "city", "nulls": "NULLS_FIRST"}
VenueSortFields
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"city"
VenueUpdateFilter
Fields
| Input Field | Description |
|---|---|
and -
[VenueUpdateFilter!]
|
|
city -
StringFieldComparison
|
|
country
-
StringFieldComparison
|
|
id -
IDFilterComparison
|
|
name -
StringFieldComparison
|
|
or -
[VenueUpdateFilter!]
|
|
space
-
StringFieldComparison
|
Example
{
"and": [VenueUpdateFilter],
"city": StringFieldComparison,
"country": StringFieldComparison,
"id": IDFilterComparison,
"name": StringFieldComparison,
"or": [VenueUpdateFilter],
"space": StringFieldComparison
}