Skip to content

Read own event ticket

Reads the customer's ticket to an event: its code for the door's QR code, its status and type, and the sessions it let them in at.

Needs the read scope.

Call

  • Tool: get_ticket
  • Scope: read
  • Reads only.
  • Acts on a store.

Arguments

Name Type Required Description
product object Yes
{
  "type": "object",
  "properties": {
    "product": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "id"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "slug": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "slug"
          ],
          "additionalProperties": false
        }
      ]
    }
  },
  "required": [
    "product"
  ],
  "additionalProperties": false
}

Answer

Name Type Required Description
product_id string Yes
ticket_code string or null Yes What the ticket’s QR code holds, shown at the door; null while a code is still being minted.
status string Yes going while it lets them in, pending or waitlisted while their request waits, canceled once it no longer does.
cancel_reason string or null Yes Why it no longer lets them in: refunded, revoked, expired, declined, or canceled when the seller canceled the event; null unless canceled.
canceled_at string or null Yes
tier object or null Yes Their ticket type; null for access with no tier.
registered_at string Yes
check_ins array of object Yes The sessions it let them in at, earliest first.

The answer’s full shape is on its API reference page.

Type to search…

↑↓ navigate↵ selectEsc close