API reference
Base URL https://tikit.co.za/api/v1. Send your key as Authorization: Bearer …. The same list as a machine-readable document is at /api/v1/openapi. Start with the guide.
GET/me
Who this key is and what it can do. Scope: none
GET/events
List events. Scope: events:read
| Parameter | In | What it does |
|---|---|---|
| status | query | draft, published, postponed, cancelled or ended. |
| cursor | query | `nextCursor` from the previous page. |
| limit | query | 1 to 100. Default 25. |
GET/events/{id}
Get one event with its tiers and check-in counts. Scope: events:read
| Parameter | In | What it does |
|---|---|---|
| id * | path | Event id. |
GET/orders
List orders, newest first (a polling trigger for Zapier). Scope: orders:read
| Parameter | In | What it does |
|---|---|---|
| event_id | query | Only this event's orders. |
| status | query | For example `paid`. |
| cursor | query | `nextCursor` from the previous page. |
| limit | query | 1 to 100. Default 25. |
GET/orders/{id}
Get one order with its tickets (never their codes). Scope: orders:read
| Parameter | In | What it does |
|---|---|---|
| id * | path | Order id. |
GET/attendees
List ticket holders for one event, with names, emails and phones. Scope: attendees:read
| Parameter | In | What it does |
|---|---|---|
| event_id * | query | Required. |
| cursor | query | `nextCursor` from the previous page. |
| limit | query | 1 to 100. Default 25. |
GET/checkins
List admitted scans for one event, oldest first. Scope: events:read
| Parameter | In | What it does |
|---|---|---|
| event_id * | query | Required. |
| cursor | query | `nextCursor` from the previous page. |
| limit | query | 1 to 100. Default 25. |
GET/events/{id}/guests
List the event's guest list (no codes). Scope: guests:write
| Parameter | In | What it does |
|---|---|---|
| id * | path | Event id. |
POST/events/{id}/guests
Give a guest complimentary tickets. Send an `Idempotency-Key` header. Scope: guests:write
| Parameter | In | What it does |
|---|---|---|
| id * | path | Event id. |
| Idempotency-Key * | header | 1 to 64 letters, numbers, dashes or underscores. |
DELETE/events/{id}/guests/{entryId}
Withdraw a guest's tickets. Scope: guests:write
| Parameter | In | What it does |
|---|---|---|
| id * | path | Event id. |
| entryId * | path | Guest entry id. |
GET/hooks
List this key's webhook subscriptions. Scope: webhooks:write
POST/hooks
Subscribe a URL to one event type (Zapier REST hooks). Scope: webhooks:write
DELETE/hooks/{id}
Remove one of this key's subscriptions. Scope: webhooks:write
| Parameter | In | What it does |
|---|---|---|
| id * | path | Hook id. |
GET/openapi
This document. Scope: none
Last updated 5 October 2026. These pages describe Tikit as it is today.