{ "info": { "name": "EntryWick API v1", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "Generated from docs/API_V1.yaml by docs/api/gen_openapi.py. Set api_key to an ewk_test_ key." }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] }, "variable": [ { "key": "base_url", "value": "https://sandbox.entrywick.io/v1" }, { "key": "public_base_url", "value": "https://sandbox.entrywick.io/v1/public" }, { "key": "api_key", "value": "" } ], "item": [ { "name": "Account", "item": [ { "name": "Get me", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/me", "host": [ "{{base_url}}" ], "path": [ "me" ], "variable": [] } } } ] }, { "name": "Org tree", "item": [ { "name": "List groups", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/groups", "host": [ "{{base_url}}" ], "path": [ "groups" ], "variable": [] } } }, { "name": "Create group", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/groups", "host": [ "{{base_url}}" ], "path": [ "groups" ], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"code\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get group", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/groups/:id", "host": [ "{{base_url}}" ], "path": [ "groups", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Update group", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{base_url}}/groups/:id", "host": [ "{{base_url}}" ], "path": [ "groups", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"code\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete group", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/groups/:id", "host": [ "{{base_url}}" ], "path": [ "groups", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } } ] }, { "name": "Events", "item": [ { "name": "List events", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/events", "host": [ "{{base_url}}" ], "path": [ "events" ], "variable": [] } } }, { "name": "Create event", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events", "host": [ "{{base_url}}" ], "path": [ "events" ], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"starts_at\": \"2027-05-01T13:00:00Z\",\n \"ends_at\": \"2027-05-01T13:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get event", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/events/:id", "host": [ "{{base_url}}" ], "path": [ "events", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Update event", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{base_url}}/events/:id", "host": [ "{{base_url}}" ], "path": [ "events", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"name\": \"string\",\n \"starts_at\": \"2027-05-01T13:00:00Z\",\n \"ends_at\": \"2027-05-01T13:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Publish event", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/publish", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "publish" ], "variable": [ { "key": "event_id", "value": "" } ] } } }, { "name": "Close event", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/close", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "close" ], "variable": [ { "key": "event_id", "value": "" } ] } } }, { "name": "Archive event", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/archive", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "archive" ], "variable": [ { "key": "event_id", "value": "" } ] } } }, { "name": "List days", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/events/:event_id/days", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "days" ], "variable": [ { "key": "event_id", "value": "" } ] } } }, { "name": "Create day", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/days", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "days" ], "variable": [ { "key": "event_id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"code\": \"string\",\n \"name\": \"string\",\n \"starts_at\": \"2027-05-01T13:00:00Z\",\n \"ends_at\": \"2027-05-01T13:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get day", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/events/:event_id/days/:id", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "days", ":id" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] } } }, { "name": "Update day", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{base_url}}/events/:event_id/days/:id", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "days", ":id" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"code\": \"string\",\n \"name\": \"string\",\n \"starts_at\": \"2027-05-01T13:00:00Z\",\n \"ends_at\": \"2027-05-01T13:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete day", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/events/:event_id/days/:id", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "days", ":id" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] } } }, { "name": "List attendee types", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/events/:event_id/attendee-types", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "attendee-types" ], "variable": [ { "key": "event_id", "value": "" } ] } } }, { "name": "Create attendee type", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/attendee-types", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "attendee-types" ], "variable": [ { "key": "event_id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"id\": \"01j7q3m4r7x8y9zabcdefghjkm\",\n \"code\": \"string\",\n \"name\": \"string\",\n \"day_mode\": \"all\",\n \"companion_ticket_mode\": \"none\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get attendee type", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/events/:event_id/attendee-types/:id", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "attendee-types", ":id" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] } } }, { "name": "Update attendee type", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{base_url}}/events/:event_id/attendee-types/:id", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "attendee-types", ":id" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"id\": \"01j7q3m4r7x8y9zabcdefghjkm\",\n \"code\": \"string\",\n \"name\": \"string\",\n \"day_mode\": \"all\",\n \"companion_ticket_mode\": \"none\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete attendee type", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/events/:event_id/attendee-types/:id", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "attendee-types", ":id" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] } } }, { "name": "List registration forms", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/events/:event_id/registration-forms", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "registration-forms" ], "variable": [ { "key": "event_id", "value": "" } ] } } }, { "name": "Create registration form", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/registration-forms", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "registration-forms" ], "variable": [ { "key": "event_id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"id\": \"01j7q3m4r7x8y9zabcdefghjkm\",\n \"code\": \"string\",\n \"name\": \"string\",\n \"kind\": \"public\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get registration form", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/events/:event_id/registration-forms/:id", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "registration-forms", ":id" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] } } }, { "name": "Update registration form", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{base_url}}/events/:event_id/registration-forms/:id", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "registration-forms", ":id" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"id\": \"01j7q3m4r7x8y9zabcdefghjkm\",\n \"code\": \"string\",\n \"name\": \"string\",\n \"kind\": \"public\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete registration form", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/events/:event_id/registration-forms/:id", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "registration-forms", ":id" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] } } } ] }, { "name": "Check-in", "item": [ { "name": "List check in points", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/events/:event_id/check-in-points", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "check-in-points" ], "variable": [ { "key": "event_id", "value": "" } ] } } }, { "name": "Create check in point", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/check-in-points", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "check-in-points" ], "variable": [ { "key": "event_id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"id\": \"01j7q3m4r7x8y9zabcdefghjkm\",\n \"code\": \"string\",\n \"name\": \"string\",\n \"kind\": \"satellite\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get check in point", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/events/:event_id/check-in-points/:id", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "check-in-points", ":id" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] } } }, { "name": "Update check in point", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{base_url}}/events/:event_id/check-in-points/:id", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "check-in-points", ":id" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"id\": \"01j7q3m4r7x8y9zabcdefghjkm\",\n \"code\": \"string\",\n \"name\": \"string\",\n \"kind\": \"satellite\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete check in point", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/events/:event_id/check-in-points/:id", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "check-in-points", ":id" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] } } }, { "name": "List checkins", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/events/:event_id/checkins", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "checkins" ], "variable": [ { "key": "event_id", "value": "" } ] } } }, { "name": "Scan", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/scan", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "scan" ], "variable": [ { "key": "event_id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"code\": \"string\",\n \"check_in_point\": \"string\",\n \"client_uuid\": \"string\",\n \"scanned_at\": \"2027-05-01T13:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Scan batch", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/scan/batch", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "scan", "batch" ], "variable": [ { "key": "event_id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"scans\": []\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get scanner manifest", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/events/:event_id/scan/manifest", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "scan", "manifest" ], "variable": [ { "key": "event_id", "value": "" } ] } } }, { "name": "Override checkin", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/checkins/:id/override", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "checkins", ":id", "override" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Pair device", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/devices/pair", "host": [ "{{base_url}}" ], "path": [ "devices", "pair" ], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"code\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Kiosk search", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/kiosk/search", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "kiosk", "search" ], "variable": [ { "key": "event_id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"first_name\": \"string\",\n \"last_name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Kiosk checkin", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/kiosk/checkin", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "kiosk", "checkin" ], "variable": [ { "key": "event_id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"match\": \"string\",\n \"client_uuid\": \"string\",\n \"scanned_at\": \"2027-05-01T13:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Kiosk unlock", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/kiosk/unlock", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "kiosk", "unlock" ], "variable": [ { "key": "event_id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"code\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get roster delta", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/events/:event_id/scan/roster", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "scan", "roster" ], "variable": [ { "key": "event_id", "value": "" } ] } } }, { "name": "Download roster snapshot", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/rosters/:tenant_id/:event_id/:scope", "host": [ "{{base_url}}" ], "path": [ "rosters", ":tenant_id", ":event_id", ":scope" ], "variable": [ { "key": "tenant_id", "value": "" }, { "key": "event_id", "value": "" }, { "key": "scope", "value": "" } ] } } } ] }, { "name": "Registrations", "item": [ { "name": "List registrations", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/events/:event_id/registrations", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "registrations" ], "variable": [ { "key": "event_id", "value": "" } ] } } }, { "name": "Create registration", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/registrations", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "registrations" ], "variable": [ { "key": "event_id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"attendees\": []\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get registration", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/events/:event_id/registrations/:id", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "registrations", ":id" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] } } }, { "name": "Update registration", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{base_url}}/events/:event_id/registrations/:id", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "registrations", ":id" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"attendees\": []\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Approve registration", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/registrations/:id/approve", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "registrations", ":id", "approve" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] } } }, { "name": "Reject registration", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/registrations/:id/reject", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "registrations", ":id", "reject" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Confirm registration", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/registrations/:id/confirm", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "registrations", ":id", "confirm" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] } } }, { "name": "Cancel registration", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/registrations/:id/cancel", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "registrations", ":id", "cancel" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"string\",\n \"refund\": true\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Mark Paid registration", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/registrations/:id/mark-paid", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "registrations", ":id", "mark-paid" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": 1,\n \"reference\": \"string\",\n \"note\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Refund registration", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/registrations/:id/refund", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "registrations", ":id", "refund" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"amount\": 1\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Promote registration", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/registrations/:id/promote", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "registrations", ":id", "promote" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Add attendee", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/registrations/:id/attendees", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "registrations", ":id", "attendees" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"attendee_type\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List attendees", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/events/:event_id/attendees", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "attendees" ], "variable": [ { "key": "event_id", "value": "" } ] } } }, { "name": "Get attendee", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/events/:event_id/attendees/:id", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "attendees", ":id" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] } } }, { "name": "Update attendee", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{base_url}}/events/:event_id/attendees/:id", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "attendees", ":id" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"attendee_type\": \"string\",\n \"first_name\": \"string\",\n \"last_name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Transfer attendee", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/attendees/:id/transfer", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "attendees", ":id", "transfer" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"first_name\": \"string\",\n \"last_name\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Cancel attendee", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/attendees/:id/cancel", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "attendees", ":id", "cancel" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Days attendee", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/attendees/:id/days", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "attendees", ":id", "days" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"days\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List households", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/events/:event_id/households", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "households" ], "variable": [ { "key": "event_id", "value": "" } ] } } }, { "name": "Get household", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/events/:event_id/households/:id", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "households", ":id" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] } } } ] }, { "name": "Contacts", "item": [ { "name": "List contacts", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/contacts", "host": [ "{{base_url}}" ], "path": [ "contacts" ], "variable": [] } } }, { "name": "Get contact", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/contacts/:id", "host": [ "{{base_url}}" ], "path": [ "contacts", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Update contact", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{base_url}}/contacts/:id", "host": [ "{{base_url}}" ], "path": [ "contacts", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"id\": \"01j7q3m4r7x8y9zabcdefghjkm\",\n \"contact_status\": \"ok\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Tickets", "item": [ { "name": "List tickets", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/events/:event_id/tickets", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "tickets" ], "variable": [ { "key": "event_id", "value": "" } ] } } }, { "name": "Get ticket", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/events/:event_id/tickets/:id", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "tickets", ":id" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] } } }, { "name": "Issue ticket", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/tickets/issue", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "tickets", "issue" ], "variable": [ { "key": "event_id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"attendee_id\": \"01j7q3m4r7x8y9zabcdefghjkm\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Send ticket", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/tickets/:id/send", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "tickets", ":id", "send" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] } } }, { "name": "Void ticket", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/tickets/:id/void", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "tickets", ":id", "void" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Reissue ticket", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/tickets/:id/reissue", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "tickets", ":id", "reissue" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"reason\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get ticket image", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/events/:event_id/tickets/:id/image", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "tickets", ":id", "image" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] } } } ] }, { "name": "Communications", "item": [ { "name": "List communication schedules", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/events/:event_id/communications", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "communications" ], "variable": [ { "key": "event_id", "value": "" } ] } } }, { "name": "Create communication schedule", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/communications", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "communications" ], "variable": [ { "key": "event_id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"id\": \"01j7q3m4r7x8y9zabcdefghjkm\",\n \"name\": \"string\",\n \"trigger\": \"string\",\n \"channel\": \"email\",\n \"template_id\": \"01j7q3m4r7x8y9zabcdefghjkm\",\n \"status\": \"scheduled\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get communication schedule", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/events/:event_id/communications/:id", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "communications", ":id" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] } } }, { "name": "Update communication schedule", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{base_url}}/events/:event_id/communications/:id", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "communications", ":id" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"id\": \"01j7q3m4r7x8y9zabcdefghjkm\",\n \"name\": \"string\",\n \"trigger\": \"string\",\n \"channel\": \"email\",\n \"template_id\": \"01j7q3m4r7x8y9zabcdefghjkm\",\n \"status\": \"scheduled\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete communication schedule", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/events/:event_id/communications/:id", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "communications", ":id" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] } } }, { "name": "Pause schedule", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/communications/:id/pause", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "communications", ":id", "pause" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] } } }, { "name": "Resume schedule", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/communications/:id/resume", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "communications", ":id", "resume" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] } } }, { "name": "Send Now schedule", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/communications/:id/send-now", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "communications", ":id", "send-now" ], "variable": [ { "key": "event_id", "value": "" }, { "key": "id", "value": "" } ] } } }, { "name": "Send test message", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/communications/test", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "communications", "test" ], "variable": [ { "key": "event_id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"template_id\": \"01j7q3m4r7x8y9zabcdefghjkm\",\n \"to\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List messages", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/messages", "host": [ "{{base_url}}" ], "path": [ "messages" ], "variable": [] } } } ] }, { "name": "Bulk", "item": [ { "name": "Create import", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/imports", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "imports" ], "variable": [ { "key": "event_id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"batch_label\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Create export", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/exports", "host": [ "{{base_url}}" ], "path": [ "exports" ], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"resource\": \"registrations\",\n \"format\": \"csv\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get job", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/jobs/:id", "host": [ "{{base_url}}" ], "path": [ "jobs", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "List jobs", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/jobs", "host": [ "{{base_url}}" ], "path": [ "jobs" ], "variable": [] } } } ] }, { "name": "Webhooks", "item": [ { "name": "List webhook endpoints", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/webhooks", "host": [ "{{base_url}}" ], "path": [ "webhooks" ], "variable": [] } } }, { "name": "Create webhook endpoint", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/webhooks", "host": [ "{{base_url}}" ], "path": [ "webhooks" ], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"string\",\n \"events\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Get webhook endpoint", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/webhooks/:id", "host": [ "{{base_url}}" ], "path": [ "webhooks", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Update webhook endpoint", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{base_url}}/webhooks/:id", "host": [ "{{base_url}}" ], "path": [ "webhooks", ":id" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"url\": \"string\",\n \"events\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete webhook endpoint", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{base_url}}/webhooks/:id", "host": [ "{{base_url}}" ], "path": [ "webhooks", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Rotate webhook secret", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/webhooks/:id/rotate-secret", "host": [ "{{base_url}}" ], "path": [ "webhooks", ":id", "rotate-secret" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Send test webhook", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/webhooks/:id/test", "host": [ "{{base_url}}" ], "path": [ "webhooks", ":id", "test" ], "variable": [ { "key": "id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"event\": \"string\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "List deliveries", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/webhooks/:id/deliveries", "host": [ "{{base_url}}" ], "path": [ "webhooks", ":id", "deliveries" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Replay delivery", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/webhooks/deliveries/:delivery_id/replay", "host": [ "{{base_url}}" ], "path": [ "webhooks", "deliveries", ":delivery_id", "replay" ], "variable": [ { "key": "delivery_id", "value": "" } ] } } } ] }, { "name": "Event templates", "item": [ { "name": "List event templates", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/templates", "host": [ "{{base_url}}" ], "path": [ "templates" ], "variable": [] } } }, { "name": "Get event template document", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/templates/:id", "host": [ "{{base_url}}" ], "path": [ "templates", ":id" ], "variable": [ { "key": "id", "value": "" } ] } } }, { "name": "Import event template", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/templates/import", "host": [ "{{base_url}}" ], "path": [ "templates", "import" ], "variable": [] }, "body": { "mode": "raw", "raw": "{\n \"event_template_id\": \"01j7q3m4r7x8y9zabcdefghjkm\",\n \"document\": {},\n \"placeholders\": {}\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Export event template", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{base_url}}/events/:event_id/export-event-template", "host": [ "{{base_url}}" ], "path": [ "events", ":event_id", "export-event-template" ], "variable": [ { "key": "event_id", "value": "" } ] }, "body": { "mode": "raw", "raw": "{\n \"code\": \"string\",\n \"name\": \"string\",\n \"visibility\": \"tenant\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Public", "item": [ { "name": "Get public event", "request": { "method": "GET", "header": [], "url": { "raw": "{{public_base_url}}/events/:slug", "host": [ "{{public_base_url}}" ], "path": [ "events", ":slug" ], "variable": [ { "key": "slug", "value": "" } ] }, "auth": { "type": "noauth" } } }, { "name": "Public register", "request": { "method": "POST", "header": [ { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{public_base_url}}/events/:slug/register", "host": [ "{{public_base_url}}" ], "path": [ "events", ":slug", "register" ], "variable": [ { "key": "slug", "value": "" } ] }, "auth": { "type": "noauth" }, "body": { "mode": "raw", "raw": "{\n \"attendees\": []\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Lookup ticket", "request": { "method": "GET", "header": [], "url": { "raw": "{{public_base_url}}/tickets/:code", "host": [ "{{public_base_url}}" ], "path": [ "tickets", ":code" ], "variable": [ { "key": "code", "value": "" } ] }, "auth": { "type": "noauth" } } }, { "name": "Household tickets", "request": { "method": "GET", "header": [], "url": { "raw": "{{public_base_url}}/households/:token", "host": [ "{{public_base_url}}" ], "path": [ "households", ":token" ], "variable": [ { "key": "token", "value": "" } ] }, "auth": { "type": "noauth" } } }, { "name": "Self-service registration", "request": { "method": "GET", "header": [], "url": { "raw": "{{public_base_url}}/self-service/:registration_id", "host": [ "{{public_base_url}}" ], "path": [ "self-service", ":registration_id" ], "variable": [ { "key": "registration_id", "value": "" } ] }, "auth": { "type": "noauth" } } } ] } ] }