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.

Contact

API Support

hello@tiketo.eu

https://tiketo.eu

Terms of Service

https://tiketo.eu

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
        parameters
        createdAt
        updatedAt
        share {
          ...PassShareFragment
        }
      }
      pass {
        id
        workspaceId
        templateId
        parameters
        createdAt
        updatedAt
        share {
          ...PassShareFragment
        }
      }
      passTemplates {
        id
        name
      }
      tiketoConfig {
        id
        workspaceId
        maskedToken
        hasToken
        createdAt
        updatedAt
      }
      members {
        id
        workspaceId
        email
        phone
        externalId
        firstName
        lastName
        metadata
        createdAt
        updatedAt
        lastActivityAt
      }
      member {
        id
        workspaceId
        email
        phone
        externalId
        firstName
        lastName
        metadata
        createdAt
        updatedAt
        lastActivityAt
      }
    }
  }
}

Response

{"data": {"token": {"workspace": Workspace}}}

Mutations

`deleteMember`

Response

Returns a Member!

Arguments

Name	Description
`workspaceId` - `ID`
`id` - `ID!`

Example

Query

mutation DeleteMember(
  $workspaceId: ID,
  $id: ID!
) {
  deleteMember(
    workspaceId: $workspaceId,
    id: $id
  ) {
    id
    workspaceId
    email
    phone
    externalId
    firstName
    lastName
    metadata
    createdAt
    updatedAt
    lastActivityAt
  }
}

Variables

{"workspaceId": 4, "id": "4"}

Response

{
  "data": {
    "deleteMember": {
      "id": "4",
      "workspaceId": 4,
      "email": "abc123",
      "phone": "xyz789",
      "externalId": "abc123",
      "firstName": "abc123",
      "lastName": "xyz789",
      "metadata": AWSJSON,
      "createdAt": "abc123",
      "updatedAt": "xyz789",
      "lastActivityAt": "abc123"
    }
  }
}

Mutations

`deletePass`

Response

Returns a Pass!

Arguments

Name	Description
`workspaceId` - `ID`
`id` - `ID!`

Example

Query

mutation DeletePass(
  $workspaceId: ID,
  $id: ID!
) {
  deletePass(
    workspaceId: $workspaceId,
    id: $id
  ) {
    id
    workspaceId
    templateId
    parameters
    createdAt
    updatedAt
    share {
      url
      expiration
    }
  }
}

Variables

{"workspaceId": "4", "id": 4}

Response

{
  "data": {
    "deletePass": {
      "id": "4",
      "workspaceId": 4,
      "templateId": "4",
      "parameters": AWSJSON,
      "createdAt": "xyz789",
      "updatedAt": "abc123",
      "share": PassShare
    }
  }
}

Mutations

`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
  ) {
    id
    workspaceId
    email
    phone
    externalId
    firstName
    lastName
    metadata
    createdAt
    updatedAt
    lastActivityAt
  }
}

Variables

{"workspaceId": 4, "input": MemberInput}

Response

{
  "data": {
    "putMember": {
      "id": "4",
      "workspaceId": "4",
      "email": "abc123",
      "phone": "xyz789",
      "externalId": "xyz789",
      "firstName": "xyz789",
      "lastName": "xyz789",
      "metadata": AWSJSON,
      "createdAt": "abc123",
      "updatedAt": "xyz789",
      "lastActivityAt": "abc123"
    }
  }
}

Mutations

`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
    parameters
    createdAt
    updatedAt
    share {
      url
      expiration
    }
  }
}

Variables

{"workspaceId": 4, "input": PassInput}

Response

{
  "data": {
    "putPass": {
      "id": 4,
      "workspaceId": "4",
      "templateId": 4,
      "parameters": AWSJSON,
      "createdAt": "abc123",
      "updatedAt": "abc123",
      "share": PassShare
    }
  }
}

Types

AWSJSON

Example

AWSJSON

Types

Boolean

Description

The Boolean scalar type represents true or false.

Types

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

Types

Member

Fields

Field Name	Description
`id` - `ID!`
`workspaceId` - `ID!`
`email` - `String`
`phone` - `String`
`externalId` - `String`
`firstName` - `String`
`lastName` - `String`
`metadata` - `AWSJSON`
`createdAt` - `String!`
`updatedAt` - `String!`
`lastActivityAt` - `String`

Example

{
  "id": "4",
  "workspaceId": "4",
  "email": "abc123",
  "phone": "abc123",
  "externalId": "xyz789",
  "firstName": "xyz789",
  "lastName": "abc123",
  "metadata": AWSJSON,
  "createdAt": "xyz789",
  "updatedAt": "abc123",
  "lastActivityAt": "abc123"
}

Types

MemberInput

Fields

Input Field	Description
`id` - `ID`
`email` - `String`
`phone` - `String`
`externalId` - `String`
`firstName` - `String`
`lastName` - `String`
`metadata` - `AWSJSON`

Example

{
  "id": "4",
  "email": "xyz789",
  "phone": "xyz789",
  "externalId": "abc123",
  "firstName": "xyz789",
  "lastName": "abc123",
  "metadata": AWSJSON
}

Types

Pass

Fields

Field Name	Description
`id` - `ID!`
`workspaceId` - `ID!`
`templateId` - `ID!`
`parameters` - `AWSJSON`
`createdAt` - `String!`
`updatedAt` - `String!`
`share` - `PassShare`

Example

{
  "id": 4,
  "workspaceId": 4,
  "templateId": "4",
  "parameters": AWSJSON,
  "createdAt": "xyz789",
  "updatedAt": "xyz789",
  "share": PassShare
}

Types

PassInput

Fields

Input Field	Description
`id` - `ID`
`templateId` - `ID!`
`parameters` - `AWSJSON`

Example

{
  "id": "4",
  "templateId": 4,
  "parameters": AWSJSON
}

Types

PassShare

Fields

Field Name	Description
`url` - `String!`
`expiration` - `String`

Example

{
  "url": "xyz789",
  "expiration": "xyz789"
}

Types

PassTemplate

Fields

Field Name	Description
`id` - `ID!`
`name` - `String!`

Example

{
  "id": "4",
  "name": "abc123"
}

Types

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"

Types

TiketoWorkspaceConfig

Fields

Field Name	Description
`id` - `ID!`
`workspaceId` - `ID!`
`maskedToken` - `String`
`hasToken` - `Boolean!`
`createdAt` - `String!`
`updatedAt` - `String!`

Example

{
  "id": 4,
  "workspaceId": "4",
  "maskedToken": "abc123",
  "hasToken": true,
  "createdAt": "xyz789",
  "updatedAt": "abc123"
}

Types

Token

Fields

Field Name	Description
`workspace` - `Workspace!`

Example

{"workspace": Workspace}

Types

Workspace

Fields

Field Name	Description
`id` - `ID!`
`name` - `String!`
`passes` - `[Pass!]!`
`pass` - `Pass`
Arguments `id` - `ID!`
`passTemplates` - `[PassTemplate!]!`
`tiketoConfig` - `TiketoWorkspaceConfig`
`members` - `[Member!]!`
`member` - `Member`
Arguments `id` - `ID!`

Example

{
  "id": "4",
  "name": "xyz789",
  "passes": [Pass],
  "pass": Pass,
  "passTemplates": [PassTemplate],
  "tiketoConfig": TiketoWorkspaceConfig,
  "members": [Member],
  "member": Member
}

Documentation by Anvil SpectaQL