Tiketo CMS API Reference
Welcome to the Tiketo CMS API reference.
Authorization
All requests to this API require an API token sent in the Authorization header:
Authorization: TOKEN {your_token}
You can obtain API tokens in your workspace settings.
Passes
Create and manage digital passes for your members. Use the putPass mutation to create or update passes.
Members
Manage your workspace members and their data using the member mutations.
Terms of Service
API Endpoints
# Production:
https://api.cms.tiketo.eu/graphql
Headers
# Provide API TOKEN created in workspace settings
Authorization: TOKEN <YOUR_TOKEN_HERE>Queries
token
Response
Returns a Token
Example
Query
query Token {
token {
workspace {
id
name
passes {
id
workspaceId
templateId
memberId
parameters
expirationDate
voided
createdAt
updatedAt
share {
...PassShareFragment
}
}
pass {
id
workspaceId
templateId
memberId
parameters
expirationDate
voided
createdAt
updatedAt
share {
...PassShareFragment
}
}
passTemplates {
id
name
}
tiketoConfig {
id
workspaceId
maskedToken
hasToken
createdAt
updatedAt
}
members {
passes {
...PassFragment
}
id
workspaceId
email
phone
externalId
firstName
lastName
metadata
createdAt
updatedAt
lastActivityAt
venues {
...VenueFragment
}
}
member {
passes {
...PassFragment
}
id
workspaceId
email
phone
externalId
firstName
lastName
metadata
createdAt
updatedAt
lastActivityAt
venues {
...VenueFragment
}
}
venues {
id
workspaceId
name
description
type
address
metadata
createdAt
updatedAt
members {
...MemberFragment
}
}
venue {
id
workspaceId
name
description
type
address
metadata
createdAt
updatedAt
members {
...MemberFragment
}
}
}
}
}
Response
{"data": {"token": {"workspace": Workspace}}}
Mutations
addVenueMember
Response
Returns a Venue!
Arguments
| Name | Description |
|---|---|
workspaceId - ID
|
|
input - VenueMemberInput!
|
Example
Query
mutation AddVenueMember(
$workspaceId: ID,
$input: VenueMemberInput!
) {
addVenueMember(
workspaceId: $workspaceId,
input: $input
) {
id
workspaceId
name
description
type
address
metadata
createdAt
updatedAt
members {
passes {
id
workspaceId
templateId
memberId
parameters
expirationDate
voided
createdAt
updatedAt
share {
...PassShareFragment
}
}
id
workspaceId
email
phone
externalId
firstName
lastName
metadata
createdAt
updatedAt
lastActivityAt
venues {
id
workspaceId
name
description
type
address
metadata
createdAt
updatedAt
members {
...MemberFragment
}
}
}
}
}
Variables
{
"workspaceId": "4",
"input": VenueMemberInput
}
Response
{
"data": {
"addVenueMember": {
"id": "4",
"workspaceId": 4,
"name": "abc123",
"description": "xyz789",
"type": "abc123",
"address": AWSJSON,
"metadata": AWSJSON,
"createdAt": "abc123",
"updatedAt": "abc123",
"members": [Member]
}
}
}
deleteMember
Example
Query
mutation DeleteMember(
$workspaceId: ID,
$id: ID!
) {
deleteMember(
workspaceId: $workspaceId,
id: $id
) {
passes {
id
workspaceId
templateId
memberId
parameters
expirationDate
voided
createdAt
updatedAt
share {
url
expiration
}
}
id
workspaceId
email
phone
externalId
firstName
lastName
metadata
createdAt
updatedAt
lastActivityAt
venues {
id
workspaceId
name
description
type
address
metadata
createdAt
updatedAt
members {
passes {
...PassFragment
}
id
workspaceId
email
phone
externalId
firstName
lastName
metadata
createdAt
updatedAt
lastActivityAt
venues {
...VenueFragment
}
}
}
}
}
Variables
{"workspaceId": "4", "id": 4}
Response
{
"data": {
"deleteMember": {
"passes": [Pass],
"id": "4",
"workspaceId": "4",
"email": "xyz789",
"phone": "abc123",
"externalId": "abc123",
"firstName": "abc123",
"lastName": "abc123",
"metadata": AWSJSON,
"createdAt": "abc123",
"updatedAt": "xyz789",
"lastActivityAt": "xyz789",
"venues": [Venue]
}
}
}
deletePass
Example
Query
mutation DeletePass(
$workspaceId: ID,
$id: ID!
) {
deletePass(
workspaceId: $workspaceId,
id: $id
) {
id
workspaceId
templateId
memberId
parameters
expirationDate
voided
createdAt
updatedAt
share {
url
expiration
}
}
}
Variables
{
"workspaceId": "4",
"id": "4"
}
Response
{
"data": {
"deletePass": {
"id": "4",
"workspaceId": 4,
"templateId": 4,
"memberId": "4",
"parameters": AWSJSON,
"expirationDate": "abc123",
"voided": true,
"createdAt": "xyz789",
"updatedAt": "abc123",
"share": PassShare
}
}
}
deleteVenue
Example
Query
mutation DeleteVenue(
$workspaceId: ID,
$id: ID!
) {
deleteVenue(
workspaceId: $workspaceId,
id: $id
) {
id
workspaceId
name
description
type
address
metadata
createdAt
updatedAt
members {
passes {
id
workspaceId
templateId
memberId
parameters
expirationDate
voided
createdAt
updatedAt
share {
...PassShareFragment
}
}
id
workspaceId
email
phone
externalId
firstName
lastName
metadata
createdAt
updatedAt
lastActivityAt
venues {
id
workspaceId
name
description
type
address
metadata
createdAt
updatedAt
members {
...MemberFragment
}
}
}
}
}
Variables
{"workspaceId": 4, "id": 4}
Response
{
"data": {
"deleteVenue": {
"id": "4",
"workspaceId": "4",
"name": "abc123",
"description": "xyz789",
"type": "xyz789",
"address": AWSJSON,
"metadata": AWSJSON,
"createdAt": "xyz789",
"updatedAt": "abc123",
"members": [Member]
}
}
}
putMember
Response
Returns a Member!
Arguments
| Name | Description |
|---|---|
workspaceId - ID
|
|
input - MemberInput!
|
Example
Query
mutation PutMember(
$workspaceId: ID,
$input: MemberInput!
) {
putMember(
workspaceId: $workspaceId,
input: $input
) {
passes {
id
workspaceId
templateId
memberId
parameters
expirationDate
voided
createdAt
updatedAt
share {
url
expiration
}
}
id
workspaceId
email
phone
externalId
firstName
lastName
metadata
createdAt
updatedAt
lastActivityAt
venues {
id
workspaceId
name
description
type
address
metadata
createdAt
updatedAt
members {
passes {
...PassFragment
}
id
workspaceId
email
phone
externalId
firstName
lastName
metadata
createdAt
updatedAt
lastActivityAt
venues {
...VenueFragment
}
}
}
}
}
Variables
{
"workspaceId": "4",
"input": MemberInput
}
Response
{
"data": {
"putMember": {
"passes": [Pass],
"id": "4",
"workspaceId": "4",
"email": "xyz789",
"phone": "abc123",
"externalId": "abc123",
"firstName": "abc123",
"lastName": "abc123",
"metadata": AWSJSON,
"createdAt": "abc123",
"updatedAt": "xyz789",
"lastActivityAt": "abc123",
"venues": [Venue]
}
}
}
putPass
Response
Returns a Pass!
Arguments
| Name | Description |
|---|---|
workspaceId - ID
|
|
input - PassInput!
|
Example
Query
mutation PutPass(
$workspaceId: ID,
$input: PassInput!
) {
putPass(
workspaceId: $workspaceId,
input: $input
) {
id
workspaceId
templateId
memberId
parameters
expirationDate
voided
createdAt
updatedAt
share {
url
expiration
}
}
}
Variables
{"workspaceId": 4, "input": PassInput}
Response
{
"data": {
"putPass": {
"id": "4",
"workspaceId": 4,
"templateId": 4,
"memberId": 4,
"parameters": AWSJSON,
"expirationDate": "xyz789",
"voided": true,
"createdAt": "xyz789",
"updatedAt": "xyz789",
"share": PassShare
}
}
}
putVenue
Response
Returns a Venue!
Arguments
| Name | Description |
|---|---|
workspaceId - ID
|
|
input - VenueInput!
|
Example
Query
mutation PutVenue(
$workspaceId: ID,
$input: VenueInput!
) {
putVenue(
workspaceId: $workspaceId,
input: $input
) {
id
workspaceId
name
description
type
address
metadata
createdAt
updatedAt
members {
passes {
id
workspaceId
templateId
memberId
parameters
expirationDate
voided
createdAt
updatedAt
share {
...PassShareFragment
}
}
id
workspaceId
email
phone
externalId
firstName
lastName
metadata
createdAt
updatedAt
lastActivityAt
venues {
id
workspaceId
name
description
type
address
metadata
createdAt
updatedAt
members {
...MemberFragment
}
}
}
}
}
Variables
{
"workspaceId": "4",
"input": VenueInput
}
Response
{
"data": {
"putVenue": {
"id": "4",
"workspaceId": 4,
"name": "xyz789",
"description": "abc123",
"type": "abc123",
"address": AWSJSON,
"metadata": AWSJSON,
"createdAt": "abc123",
"updatedAt": "xyz789",
"members": [Member]
}
}
}
removeVenueMember
Response
Returns a Venue!
Arguments
| Name | Description |
|---|---|
workspaceId - ID
|
|
input - VenueMemberInput!
|
Example
Query
mutation RemoveVenueMember(
$workspaceId: ID,
$input: VenueMemberInput!
) {
removeVenueMember(
workspaceId: $workspaceId,
input: $input
) {
id
workspaceId
name
description
type
address
metadata
createdAt
updatedAt
members {
passes {
id
workspaceId
templateId
memberId
parameters
expirationDate
voided
createdAt
updatedAt
share {
...PassShareFragment
}
}
id
workspaceId
email
phone
externalId
firstName
lastName
metadata
createdAt
updatedAt
lastActivityAt
venues {
id
workspaceId
name
description
type
address
metadata
createdAt
updatedAt
members {
...MemberFragment
}
}
}
}
}
Variables
{"workspaceId": 4, "input": VenueMemberInput}
Response
{
"data": {
"removeVenueMember": {
"id": "4",
"workspaceId": 4,
"name": "xyz789",
"description": "xyz789",
"type": "xyz789",
"address": AWSJSON,
"metadata": AWSJSON,
"createdAt": "xyz789",
"updatedAt": "abc123",
"members": [Member]
}
}
}
Types
AWSJSON
Example
AWSJSON
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
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
Member
Example
{
"passes": [Pass],
"id": "4",
"workspaceId": "4",
"email": "xyz789",
"phone": "abc123",
"externalId": "xyz789",
"firstName": "xyz789",
"lastName": "xyz789",
"metadata": AWSJSON,
"createdAt": "xyz789",
"updatedAt": "xyz789",
"lastActivityAt": "xyz789",
"venues": [Venue]
}
MemberInput
Pass
Example
{
"id": "4",
"workspaceId": "4",
"templateId": "4",
"memberId": 4,
"parameters": AWSJSON,
"expirationDate": "xyz789",
"voided": true,
"createdAt": "xyz789",
"updatedAt": "xyz789",
"share": PassShare
}
PassInput
PassTemplate
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
"xyz789"
TiketoWorkspaceConfig
Token
Fields
| Field Name | Description |
|---|---|
workspace - Workspace!
|
Example
{"workspace": Workspace}
Venue
Example
{
"id": 4,
"workspaceId": "4",
"name": "xyz789",
"description": "xyz789",
"type": "xyz789",
"address": AWSJSON,
"metadata": AWSJSON,
"createdAt": "xyz789",
"updatedAt": "xyz789",
"members": [Member]
}
VenueInput
VenueMemberInput
Workspace
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
passes - [Pass!]!
|
|
pass - Pass
|
|
Arguments
|
|
passTemplates - [PassTemplate!]!
|
|
tiketoConfig - TiketoWorkspaceConfig
|
|
members - [Member!]!
|
|
member - Member
|
|
Arguments
|
|
venues - [Venue!]!
|
|
venue - Venue
|
|
Arguments
|
|
Example
{
"id": "4",
"name": "abc123",
"passes": [Pass],
"pass": Pass,
"passTemplates": [PassTemplate],
"tiketoConfig": TiketoWorkspaceConfig,
"members": [Member],
"member": Member,
"venues": [Venue],
"venue": Venue
}