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
}
organizations {
...OrganizationFragment
}
}
venue {
id
workspaceId
name
description
type
address
metadata
createdAt
updatedAt
members {
...MemberFragment
}
organizations {
...OrganizationFragment
}
}
auditLog {
id
workspaceId
eventType
eventSource
eventTime
entityType
entityId
action
principal
data
previousData
entities {
...EntityReferenceFragment
}
createdAt
}
organizations {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
organization {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
rootOrganizations {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
isOrganizationOpenMode
checkEntityAccess {
hasAccess
throughOrganizations {
...OrganizationFragment
}
isOpenMode
}
myOrganizations {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
myAccessibleOrganizations {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
messageCampaigns {
id
workspaceId
messageHeader
messageBody
dateFrom
dateTo
templateId
totalCount
sentCount
failedCount
metadata
createdAt
updatedAt
completedAt
recipients {
...MessageCampaignRecipientFragment
}
}
messageCampaign {
id
workspaceId
messageHeader
messageBody
dateFrom
dateTo
templateId
totalCount
sentCount
failedCount
metadata
createdAt
updatedAt
completedAt
recipients {
...MessageCampaignRecipientFragment
}
}
}
}
}
Response
{"data": {"token": {"workspace": Workspace}}}
Mutations
addOrganizationMember
Description
Add a user to an organization (upsert - updates role if already member)
Response
Returns an OrganizationMember!
Arguments
| Name | Description |
|---|---|
workspaceId - ID
|
|
input - OrganizationMemberInput!
|
Example
Query
mutation AddOrganizationMember(
$workspaceId: ID,
$input: OrganizationMemberInput!
) {
addOrganizationMember(
workspaceId: $workspaceId,
input: $input
) {
organizationId
userId
workspaceId
createdAt
updatedAt
organization {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
children {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
descendants {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
entities {
organizationId
entityId
workspaceId
createdAt
organization {
...OrganizationFragment
}
}
venues {
id
workspaceId
name
description
type
address
metadata
createdAt
updatedAt
members {
...MemberFragment
}
organizations {
...OrganizationFragment
}
}
members {
organizationId
userId
workspaceId
createdAt
updatedAt
organization {
...OrganizationFragment
}
}
}
}
}
Variables
{
"workspaceId": "4",
"input": OrganizationMemberInput
}
Response
{
"data": {
"addOrganizationMember": {
"organizationId": "4",
"userId": "4",
"workspaceId": 4,
"createdAt": "abc123",
"updatedAt": "abc123",
"organization": Organization
}
}
}
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
}
organizations {
...OrganizationFragment
}
}
}
organizations {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
children {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
descendants {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
entities {
organizationId
entityId
workspaceId
createdAt
organization {
...OrganizationFragment
}
}
venues {
id
workspaceId
name
description
type
address
metadata
createdAt
updatedAt
members {
...MemberFragment
}
organizations {
...OrganizationFragment
}
}
members {
organizationId
userId
workspaceId
createdAt
updatedAt
organization {
...OrganizationFragment
}
}
}
}
}
Variables
{
"workspaceId": "4",
"input": VenueMemberInput
}
Response
{
"data": {
"addVenueMember": {
"id": 4,
"workspaceId": "4",
"name": "abc123",
"description": "abc123",
"type": "abc123",
"address": AWSJSON,
"metadata": AWSJSON,
"createdAt": "xyz789",
"updatedAt": "abc123",
"members": [Member],
"organizations": [Organization]
}
}
}
attachEntityToOrganization
Description
Attach an entity to an organization
Response
Returns an OrganizationEntityAttachment!
Arguments
| Name | Description |
|---|---|
workspaceId - ID
|
|
input - OrganizationEntityInput!
|
Example
Query
mutation AttachEntityToOrganization(
$workspaceId: ID,
$input: OrganizationEntityInput!
) {
attachEntityToOrganization(
workspaceId: $workspaceId,
input: $input
) {
organizationId
entityId
workspaceId
createdAt
organization {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
children {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
descendants {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
entities {
organizationId
entityId
workspaceId
createdAt
organization {
...OrganizationFragment
}
}
venues {
id
workspaceId
name
description
type
address
metadata
createdAt
updatedAt
members {
...MemberFragment
}
organizations {
...OrganizationFragment
}
}
members {
organizationId
userId
workspaceId
createdAt
updatedAt
organization {
...OrganizationFragment
}
}
}
}
}
Variables
{"workspaceId": 4, "input": OrganizationEntityInput}
Response
{
"data": {
"attachEntityToOrganization": {
"organizationId": 4,
"entityId": "4",
"workspaceId": 4,
"createdAt": "abc123",
"organization": Organization
}
}
}
createPassesCampaign
Description
Create a campaign targeting specific passes
Response
Returns a MessageCampaign!
Arguments
| Name | Description |
|---|---|
workspaceId - ID
|
|
input - CreatePassesCampaignInput!
|
Example
Query
mutation CreatePassesCampaign(
$workspaceId: ID,
$input: CreatePassesCampaignInput!
) {
createPassesCampaign(
workspaceId: $workspaceId,
input: $input
) {
id
workspaceId
messageHeader
messageBody
dateFrom
dateTo
templateId
totalCount
sentCount
failedCount
metadata
createdAt
updatedAt
completedAt
recipients {
campaignId
passId
workspaceId
errorMessage
processedAt
createdAt
}
}
}
Variables
{"workspaceId": 4, "input": CreatePassesCampaignInput}
Response
{
"data": {
"createPassesCampaign": {
"id": "4",
"workspaceId": "4",
"messageHeader": "xyz789",
"messageBody": "abc123",
"dateFrom": "xyz789",
"dateTo": "abc123",
"templateId": "4",
"totalCount": 123,
"sentCount": 987,
"failedCount": 987,
"metadata": AWSJSON,
"createdAt": "xyz789",
"updatedAt": "xyz789",
"completedAt": "xyz789",
"recipients": [MessageCampaignRecipient]
}
}
}
createTemplateCampaign
Description
Create a campaign targeting all passes from a template
Response
Returns a MessageCampaign!
Arguments
| Name | Description |
|---|---|
workspaceId - ID
|
|
input - CreateTemplateCampaignInput!
|
Example
Query
mutation CreateTemplateCampaign(
$workspaceId: ID,
$input: CreateTemplateCampaignInput!
) {
createTemplateCampaign(
workspaceId: $workspaceId,
input: $input
) {
id
workspaceId
messageHeader
messageBody
dateFrom
dateTo
templateId
totalCount
sentCount
failedCount
metadata
createdAt
updatedAt
completedAt
recipients {
campaignId
passId
workspaceId
errorMessage
processedAt
createdAt
}
}
}
Variables
{
"workspaceId": "4",
"input": CreateTemplateCampaignInput
}
Response
{
"data": {
"createTemplateCampaign": {
"id": "4",
"workspaceId": 4,
"messageHeader": "abc123",
"messageBody": "abc123",
"dateFrom": "xyz789",
"dateTo": "xyz789",
"templateId": "4",
"totalCount": 987,
"sentCount": 123,
"failedCount": 123,
"metadata": AWSJSON,
"createdAt": "xyz789",
"updatedAt": "xyz789",
"completedAt": "xyz789",
"recipients": [MessageCampaignRecipient]
}
}
}
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
}
}
organizations {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
}
}
}
Variables
{
"workspaceId": "4",
"id": "4"
}
Response
{
"data": {
"deleteMember": {
"passes": [Pass],
"id": "4",
"workspaceId": "4",
"email": "xyz789",
"phone": "abc123",
"externalId": "xyz789",
"firstName": "abc123",
"lastName": "abc123",
"metadata": AWSJSON,
"createdAt": "xyz789",
"updatedAt": "abc123",
"lastActivityAt": "abc123",
"venues": [Venue]
}
}
}
deleteOrganization
Description
Delete an organization (fails if has children)
Response
Returns an Organization!
Example
Query
mutation DeleteOrganization(
$workspaceId: ID,
$id: ID!
) {
deleteOrganization(
workspaceId: $workspaceId,
id: $id
) {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
children {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
descendants {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
entities {
organizationId
entityId
workspaceId
createdAt
organization {
...OrganizationFragment
}
}
venues {
id
workspaceId
name
description
type
address
metadata
createdAt
updatedAt
members {
...MemberFragment
}
organizations {
...OrganizationFragment
}
}
members {
organizationId
userId
workspaceId
createdAt
updatedAt
organization {
...OrganizationFragment
}
}
}
children {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
children {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
descendants {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
entities {
organizationId
entityId
workspaceId
createdAt
organization {
...OrganizationFragment
}
}
venues {
id
workspaceId
name
description
type
address
metadata
createdAt
updatedAt
members {
...MemberFragment
}
organizations {
...OrganizationFragment
}
}
members {
organizationId
userId
workspaceId
createdAt
updatedAt
organization {
...OrganizationFragment
}
}
}
descendants {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
children {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
descendants {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
entities {
organizationId
entityId
workspaceId
createdAt
organization {
...OrganizationFragment
}
}
venues {
id
workspaceId
name
description
type
address
metadata
createdAt
updatedAt
members {
...MemberFragment
}
organizations {
...OrganizationFragment
}
}
members {
organizationId
userId
workspaceId
createdAt
updatedAt
organization {
...OrganizationFragment
}
}
}
entities {
organizationId
entityId
workspaceId
createdAt
organization {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
}
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
}
}
organizations {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
}
members {
organizationId
userId
workspaceId
createdAt
updatedAt
organization {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
}
}
}
Variables
{"workspaceId": "4", "id": 4}
Response
{
"data": {
"deleteOrganization": {
"id": 4,
"workspaceId": 4,
"name": "xyz789",
"description": "xyz789",
"parentId": "4",
"path": "xyz789",
"depth": 987,
"metadata": AWSJSON,
"createdAt": "abc123",
"updatedAt": "abc123",
"parent": Organization,
"children": [Organization],
"descendants": [Organization],
"entities": [OrganizationEntityAttachment],
"venues": [Venue],
"members": [OrganizationMember]
}
}
}
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": "xyz789",
"voided": true,
"createdAt": "abc123",
"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
}
organizations {
...OrganizationFragment
}
}
}
organizations {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
children {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
descendants {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
entities {
organizationId
entityId
workspaceId
createdAt
organization {
...OrganizationFragment
}
}
venues {
id
workspaceId
name
description
type
address
metadata
createdAt
updatedAt
members {
...MemberFragment
}
organizations {
...OrganizationFragment
}
}
members {
organizationId
userId
workspaceId
createdAt
updatedAt
organization {
...OrganizationFragment
}
}
}
}
}
Variables
{"workspaceId": "4", "id": 4}
Response
{
"data": {
"deleteVenue": {
"id": "4",
"workspaceId": "4",
"name": "xyz789",
"description": "abc123",
"type": "xyz789",
"address": AWSJSON,
"metadata": AWSJSON,
"createdAt": "abc123",
"updatedAt": "abc123",
"members": [Member],
"organizations": [Organization]
}
}
}
detachEntityFromOrganization
Description
Detach an entity from an organization
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
workspaceId - ID
|
|
input - OrganizationEntityInput!
|
Example
Query
mutation DetachEntityFromOrganization(
$workspaceId: ID,
$input: OrganizationEntityInput!
) {
detachEntityFromOrganization(
workspaceId: $workspaceId,
input: $input
)
}
Variables
{"workspaceId": 4, "input": OrganizationEntityInput}
Response
{"data": {"detachEntityFromOrganization": false}}
moveOrganization
Description
Move organization to a new parent (recalculates paths for subtree)
Response
Returns an Organization!
Arguments
| Name | Description |
|---|---|
workspaceId - ID
|
|
input - MoveOrganizationInput!
|
Example
Query
mutation MoveOrganization(
$workspaceId: ID,
$input: MoveOrganizationInput!
) {
moveOrganization(
workspaceId: $workspaceId,
input: $input
) {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
children {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
descendants {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
entities {
organizationId
entityId
workspaceId
createdAt
organization {
...OrganizationFragment
}
}
venues {
id
workspaceId
name
description
type
address
metadata
createdAt
updatedAt
members {
...MemberFragment
}
organizations {
...OrganizationFragment
}
}
members {
organizationId
userId
workspaceId
createdAt
updatedAt
organization {
...OrganizationFragment
}
}
}
children {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
children {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
descendants {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
entities {
organizationId
entityId
workspaceId
createdAt
organization {
...OrganizationFragment
}
}
venues {
id
workspaceId
name
description
type
address
metadata
createdAt
updatedAt
members {
...MemberFragment
}
organizations {
...OrganizationFragment
}
}
members {
organizationId
userId
workspaceId
createdAt
updatedAt
organization {
...OrganizationFragment
}
}
}
descendants {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
children {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
descendants {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
entities {
organizationId
entityId
workspaceId
createdAt
organization {
...OrganizationFragment
}
}
venues {
id
workspaceId
name
description
type
address
metadata
createdAt
updatedAt
members {
...MemberFragment
}
organizations {
...OrganizationFragment
}
}
members {
organizationId
userId
workspaceId
createdAt
updatedAt
organization {
...OrganizationFragment
}
}
}
entities {
organizationId
entityId
workspaceId
createdAt
organization {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
}
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
}
}
organizations {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
}
members {
organizationId
userId
workspaceId
createdAt
updatedAt
organization {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
}
}
}
Variables
{"workspaceId": 4, "input": MoveOrganizationInput}
Response
{
"data": {
"moveOrganization": {
"id": "4",
"workspaceId": "4",
"name": "xyz789",
"description": "xyz789",
"parentId": "4",
"path": "abc123",
"depth": 987,
"metadata": AWSJSON,
"createdAt": "abc123",
"updatedAt": "xyz789",
"parent": Organization,
"children": [Organization],
"descendants": [Organization],
"entities": [OrganizationEntityAttachment],
"venues": [Venue],
"members": [OrganizationMember]
}
}
}
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
}
}
organizations {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
}
}
}
Variables
{
"workspaceId": "4",
"input": MemberInput
}
Response
{
"data": {
"putMember": {
"passes": [Pass],
"id": "4",
"workspaceId": 4,
"email": "xyz789",
"phone": "xyz789",
"externalId": "abc123",
"firstName": "abc123",
"lastName": "abc123",
"metadata": AWSJSON,
"createdAt": "abc123",
"updatedAt": "xyz789",
"lastActivityAt": "xyz789",
"venues": [Venue]
}
}
}
putOrganization
Description
Create or update an organization
Response
Returns an Organization!
Arguments
| Name | Description |
|---|---|
workspaceId - ID
|
|
input - OrganizationInput!
|
Example
Query
mutation PutOrganization(
$workspaceId: ID,
$input: OrganizationInput!
) {
putOrganization(
workspaceId: $workspaceId,
input: $input
) {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
children {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
descendants {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
entities {
organizationId
entityId
workspaceId
createdAt
organization {
...OrganizationFragment
}
}
venues {
id
workspaceId
name
description
type
address
metadata
createdAt
updatedAt
members {
...MemberFragment
}
organizations {
...OrganizationFragment
}
}
members {
organizationId
userId
workspaceId
createdAt
updatedAt
organization {
...OrganizationFragment
}
}
}
children {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
children {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
descendants {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
entities {
organizationId
entityId
workspaceId
createdAt
organization {
...OrganizationFragment
}
}
venues {
id
workspaceId
name
description
type
address
metadata
createdAt
updatedAt
members {
...MemberFragment
}
organizations {
...OrganizationFragment
}
}
members {
organizationId
userId
workspaceId
createdAt
updatedAt
organization {
...OrganizationFragment
}
}
}
descendants {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
children {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
descendants {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
entities {
organizationId
entityId
workspaceId
createdAt
organization {
...OrganizationFragment
}
}
venues {
id
workspaceId
name
description
type
address
metadata
createdAt
updatedAt
members {
...MemberFragment
}
organizations {
...OrganizationFragment
}
}
members {
organizationId
userId
workspaceId
createdAt
updatedAt
organization {
...OrganizationFragment
}
}
}
entities {
organizationId
entityId
workspaceId
createdAt
organization {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
}
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
}
}
organizations {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
}
members {
organizationId
userId
workspaceId
createdAt
updatedAt
organization {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
}
}
}
Variables
{"workspaceId": 4, "input": OrganizationInput}
Response
{
"data": {
"putOrganization": {
"id": "4",
"workspaceId": "4",
"name": "abc123",
"description": "abc123",
"parentId": "4",
"path": "xyz789",
"depth": 987,
"metadata": AWSJSON,
"createdAt": "xyz789",
"updatedAt": "xyz789",
"parent": Organization,
"children": [Organization],
"descendants": [Organization],
"entities": [OrganizationEntityAttachment],
"venues": [Venue],
"members": [OrganizationMember]
}
}
}
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": false,
"createdAt": "abc123",
"updatedAt": "abc123",
"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
}
organizations {
...OrganizationFragment
}
}
}
organizations {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
children {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
descendants {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
entities {
organizationId
entityId
workspaceId
createdAt
organization {
...OrganizationFragment
}
}
venues {
id
workspaceId
name
description
type
address
metadata
createdAt
updatedAt
members {
...MemberFragment
}
organizations {
...OrganizationFragment
}
}
members {
organizationId
userId
workspaceId
createdAt
updatedAt
organization {
...OrganizationFragment
}
}
}
}
}
Variables
{
"workspaceId": "4",
"input": VenueInput
}
Response
{
"data": {
"putVenue": {
"id": 4,
"workspaceId": 4,
"name": "abc123",
"description": "abc123",
"type": "xyz789",
"address": AWSJSON,
"metadata": AWSJSON,
"createdAt": "xyz789",
"updatedAt": "abc123",
"members": [Member],
"organizations": [Organization]
}
}
}
removeOrganizationMember
Description
Remove a user from an organization
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
workspaceId - ID
|
|
input - RemoveOrganizationMemberInput!
|
Example
Query
mutation RemoveOrganizationMember(
$workspaceId: ID,
$input: RemoveOrganizationMemberInput!
) {
removeOrganizationMember(
workspaceId: $workspaceId,
input: $input
)
}
Variables
{"workspaceId": 4, "input": RemoveOrganizationMemberInput}
Response
{"data": {"removeOrganizationMember": true}}
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
}
organizations {
...OrganizationFragment
}
}
}
organizations {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
children {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
descendants {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
entities {
organizationId
entityId
workspaceId
createdAt
organization {
...OrganizationFragment
}
}
venues {
id
workspaceId
name
description
type
address
metadata
createdAt
updatedAt
members {
...MemberFragment
}
organizations {
...OrganizationFragment
}
}
members {
organizationId
userId
workspaceId
createdAt
updatedAt
organization {
...OrganizationFragment
}
}
}
}
}
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": "xyz789",
"members": [Member],
"organizations": [Organization]
}
}
}
updateOrganizationMemberRole
Description
Update a user's role in an organization
Response
Returns an OrganizationMember
Arguments
| Name | Description |
|---|---|
workspaceId - ID
|
|
input - UpdateOrganizationMemberRoleInput!
|
Example
Query
mutation UpdateOrganizationMemberRole(
$workspaceId: ID,
$input: UpdateOrganizationMemberRoleInput!
) {
updateOrganizationMemberRole(
workspaceId: $workspaceId,
input: $input
) {
organizationId
userId
workspaceId
createdAt
updatedAt
organization {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
children {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
descendants {
id
workspaceId
name
description
parentId
path
depth
metadata
createdAt
updatedAt
parent {
...OrganizationFragment
}
children {
...OrganizationFragment
}
descendants {
...OrganizationFragment
}
entities {
...OrganizationEntityAttachmentFragment
}
venues {
...VenueFragment
}
members {
...OrganizationMemberFragment
}
}
entities {
organizationId
entityId
workspaceId
createdAt
organization {
...OrganizationFragment
}
}
venues {
id
workspaceId
name
description
type
address
metadata
createdAt
updatedAt
members {
...MemberFragment
}
organizations {
...OrganizationFragment
}
}
members {
organizationId
userId
workspaceId
createdAt
updatedAt
organization {
...OrganizationFragment
}
}
}
}
}
Variables
{
"workspaceId": "4",
"input": UpdateOrganizationMemberRoleInput
}
Response
{
"data": {
"updateOrganizationMemberRole": {
"organizationId": "4",
"userId": "4",
"workspaceId": 4,
"createdAt": "abc123",
"updatedAt": "xyz789",
"organization": Organization
}
}
}
Types
AWSDateTime
Example
AWSDateTime
AWSJSON
Example
AWSJSON
AuditLog
Description
Audit log entry representing a single event in the system
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
workspaceId - ID!
|
|
eventType - String!
|
Event type identifier (e.g., 'passes.PassCreated') |
eventSource - String!
|
Source of the event |
eventTime - AWSDateTime!
|
When the event occurred |
entityType - String!
|
Entity type affected (e.g., 'pass', 'member', 'venue') |
entityId - ID!
|
ID of the affected entity |
action - String!
|
Action performed (e.g., 'created', 'updated', 'deleted') |
principal - String
|
Principal who triggered the action (format: 'user: |
data - AWSJSON!
|
Current entity data at time of event |
previousData - AWSJSON
|
Previous entity data (for updates) |
entities - [EntityReference!]
|
All entities affected by this event (for UI tags) |
createdAt - AWSDateTime!
|
When this audit log was created |
Example
{
"id": "4",
"workspaceId": "4",
"eventType": "xyz789",
"eventSource": "xyz789",
"eventTime": AWSDateTime,
"entityType": "xyz789",
"entityId": 4,
"action": "xyz789",
"principal": "abc123",
"data": AWSJSON,
"previousData": AWSJSON,
"entities": [EntityReference],
"createdAt": AWSDateTime
}
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
CreatePassesCampaignInput
Description
Input for creating a campaign targeting specific passes
Fields
| Input Field | Description |
|---|---|
passIds - [ID!]!
|
IDs of passes to send messages to |
messageHeader - String
|
Message header (optional, max 64 chars for Apple Wallet) |
messageBody - String!
|
Message body content (required) |
dateFrom - String
|
Message validity start date |
dateTo - String
|
Message validity end date |
metadata - AWSJSON
|
Additional metadata |
Example
{
"passIds": [4],
"messageHeader": "abc123",
"messageBody": "xyz789",
"dateFrom": "abc123",
"dateTo": "abc123",
"metadata": AWSJSON
}
CreateTemplateCampaignInput
Description
Input for creating a campaign targeting all passes from one or more templates
Fields
| Input Field | Description |
|---|---|
templateIds - [ID!]!
|
Template IDs to target (one message will be sent to all passes of each template) |
messageHeader - String
|
Message header (optional, max 64 chars for Apple Wallet) |
messageBody - String!
|
Message body content (required) |
dateFrom - String
|
Message validity start date |
dateTo - String
|
Message validity end date |
metadata - AWSJSON
|
Additional metadata |
Example
{
"templateIds": [4],
"messageHeader": "xyz789",
"messageBody": "abc123",
"dateFrom": "xyz789",
"dateTo": "xyz789",
"metadata": AWSJSON
}
EntityAccessCheck
Fields
| Field Name | Description |
|---|---|
hasAccess - Boolean!
|
Whether the user has access to this entity |
throughOrganizations - [Organization!]!
|
Organizations through which access is granted (empty if open mode or no access) |
isOpenMode - Boolean!
|
Whether access is granted via open mode |
Example
{
"hasAccess": true,
"throughOrganizations": [Organization],
"isOpenMode": true
}
EntityReference
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"
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
Member
Example
{
"passes": [Pass],
"id": 4,
"workspaceId": 4,
"email": "abc123",
"phone": "abc123",
"externalId": "abc123",
"firstName": "abc123",
"lastName": "xyz789",
"metadata": AWSJSON,
"createdAt": "abc123",
"updatedAt": "abc123",
"lastActivityAt": "abc123",
"venues": [Venue]
}
MemberInput
MessageCampaign
Description
Message campaign for sending notifications to passes
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
workspaceId - ID!
|
|
messageHeader - String
|
Message header (optional) |
messageBody - String!
|
Message body content |
dateFrom - String
|
Message validity start date |
dateTo - String
|
Message validity end date |
templateId - ID
|
Template ID (for template-based campaigns) |
totalCount - Int!
|
Total number of recipients |
sentCount - Int!
|
Number of messages sent |
failedCount - Int!
|
Number of failed messages |
metadata - AWSJSON
|
Additional metadata |
createdAt - String!
|
|
updatedAt - String!
|
|
completedAt - String
|
When the campaign completed processing |
recipients - [MessageCampaignRecipient!]!
|
Recipients of this campaign |
Example
{
"id": 4,
"workspaceId": "4",
"messageHeader": "abc123",
"messageBody": "abc123",
"dateFrom": "xyz789",
"dateTo": "xyz789",
"templateId": "4",
"totalCount": 987,
"sentCount": 987,
"failedCount": 987,
"metadata": AWSJSON,
"createdAt": "abc123",
"updatedAt": "xyz789",
"completedAt": "abc123",
"recipients": [MessageCampaignRecipient]
}
MessageCampaignRecipient
Description
Individual recipient in a message campaign
Example
{
"campaignId": "4",
"passId": "4",
"workspaceId": "4",
"errorMessage": "xyz789",
"processedAt": "xyz789",
"createdAt": "abc123"
}
MoveOrganizationInput
Organization
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
workspaceId - ID!
|
|
name - String!
|
|
description - String
|
|
parentId - ID
|
|
path - String!
|
Materialized path from root to parent (comma-separated IDs) |
depth - Int!
|
Depth in hierarchy (0 for root orgs) |
metadata - AWSJSON
|
|
createdAt - String!
|
|
updatedAt - String!
|
|
parent - Organization
|
Parent organization (null for root orgs) |
children - [Organization!]!
|
Direct child organizations |
descendants - [Organization!]!
|
All descendant organizations (recursive) |
entities - [OrganizationEntityAttachment!]!
|
Entities attached to this organization |
venues - [Venue!]!
|
Venues attached to this organization |
members - [OrganizationMember!]!
|
Members of this organization |
Example
{
"id": "4",
"workspaceId": "4",
"name": "abc123",
"description": "xyz789",
"parentId": "4",
"path": "abc123",
"depth": 987,
"metadata": AWSJSON,
"createdAt": "xyz789",
"updatedAt": "abc123",
"parent": Organization,
"children": [Organization],
"descendants": [Organization],
"entities": [OrganizationEntityAttachment],
"venues": [Venue],
"members": [OrganizationMember]
}
OrganizationEntityAttachment
Fields
| Field Name | Description |
|---|---|
organizationId - ID!
|
|
entityId - ID!
|
|
workspaceId - ID!
|
|
createdAt - String!
|
|
organization - Organization
|
The organization this entity is attached to |
Example
{
"organizationId": "4",
"entityId": "4",
"workspaceId": "4",
"createdAt": "abc123",
"organization": Organization
}
OrganizationEntityInput
OrganizationInput
OrganizationMember
Example
{
"organizationId": "4",
"userId": 4,
"workspaceId": 4,
"createdAt": "xyz789",
"updatedAt": "abc123",
"organization": Organization
}
OrganizationMemberInput
Pass
Example
{
"id": "4",
"workspaceId": 4,
"templateId": "4",
"memberId": 4,
"parameters": AWSJSON,
"expirationDate": "abc123",
"voided": false,
"createdAt": "abc123",
"updatedAt": "abc123",
"share": PassShare
}
PassInput
PassTemplate
RemoveOrganizationMemberInput
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"
TiketoWorkspaceConfig
Token
Fields
| Field Name | Description |
|---|---|
workspace - Workspace!
|
Example
{"workspace": Workspace}
UpdateOrganizationMemberRoleInput
Venue
Example
{
"id": 4,
"workspaceId": 4,
"name": "xyz789",
"description": "abc123",
"type": "xyz789",
"address": AWSJSON,
"metadata": AWSJSON,
"createdAt": "abc123",
"updatedAt": "xyz789",
"members": [Member],
"organizations": [Organization]
}
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
|
|
auditLog - AuditLog
|
Get a single audit log by ID |
Arguments
|
|
organizations - [Organization!]!
|
List all organizations in the workspace |
organization - Organization
|
Get a specific organization by ID |
Arguments
|
|
rootOrganizations - [Organization!]!
|
Get root-level organizations (no parent) |
isOrganizationOpenMode - Boolean!
|
Check if workspace is in open mode (no organizations) |
checkEntityAccess - EntityAccessCheck!
|
Check if current user has access to an entity |
Arguments
|
|
myOrganizations - [Organization!]!
|
Get organizations the current user is a direct member of |
myAccessibleOrganizations - [Organization!]!
|
Get all organizations the current user can access (direct + descendant) |
messageCampaigns - [MessageCampaign!]!
|
Get all message campaigns for this workspace |
messageCampaign - MessageCampaign
|
Get a specific message campaign by ID |
Arguments
|
|
Example
{
"id": 4,
"name": "xyz789",
"passes": [Pass],
"pass": Pass,
"passTemplates": [PassTemplate],
"tiketoConfig": TiketoWorkspaceConfig,
"members": [Member],
"member": Member,
"venues": [Venue],
"venue": Venue,
"auditLog": AuditLog,
"organizations": [Organization],
"organization": Organization,
"rootOrganizations": [Organization],
"isOrganizationOpenMode": false,
"checkEntityAccess": EntityAccessCheck,
"myOrganizations": [Organization],
"myAccessibleOrganizations": [Organization],
"messageCampaigns": [MessageCampaign],
"messageCampaign": MessageCampaign
}