Open-source event management and ticket selling platform — perfect for concerts, conferences, and everything in between 🎟️ If you find this project helpful, please consider giving us a star ⭐️
PHP attendize-alternativedoor-managementevent-check-inevent-managementevent-registrationevent-ticketingeventbrite-alternativeeventslaravelopen-sourcephpreactself-hostedsell-ticketssell-tickets-onlineticket-sellingticketing-systemtickettailor-alternativetito-alternative
{
"openapi": "3.1.0",
"info": {
"title": "Hi.Events",
"description": "The Hi.Events API powers event management, ticketing, and checkout.\n\n## Authentication\n\nManagement endpoints require a bearer token in the `Authorization` header. Endpoints under `/public/*` — event pages, checkout, ticket lookup, check-in — require no authentication and are marked *(public)*.\n\n### API keys\n\nFor integrations, create an API key under **Settings → API keys** and send it with every request:\n\n```bash\ncurl https://your-hi-events-host/api/events \\\n -H \"Authorization: Bearer hie_…\" \\\n -H \"Accept: application/json\"\n```\n\n- A key acts as the person who created it, in the one account it was created in, with that person's role, permissions and event access. It never has more access than its owner, and changes to the owner's role apply straight away.\n- **Read and write** keys can call every endpoint the owner can. **Read-only** keys can call `GET` endpoints and exports; other requests return `403` with `error_code: API_KEY_READ_ONLY`.\n- Keys can't sign in, or manage the user's profile, sign-in security, team, API keys, payouts or account settings. Those endpoints return `403` with `error_code: API_KEY_NOT_ALLOWED`.\n- An expired, revoked or unknown key returns `401`. A key is revoked when its owner revokes it, when an admin revokes it, when the owner is deactivated or leaves the account, and when the owner's password is reset or their single sign-on changes.\n- The full key is shown once, when it's created. Hi.Events stores only a hash of it.\n\n### Session tokens\n\nThe Hi.Events web app uses a JWT obtained from `POST /auth/login`. It works on every management endpoint, including the ones API keys can't use.\n\n### Two-factor authentication\n\nWhen the user has two-factor authentication turned on, `POST /auth/login` returns `200` with `token: null`, `two_factor_required: true` and a `two_factor_challenge_token` that is valid for 10 minutes. Complete the login with `POST /auth/login/two-factor`, sending the challenge token plus either a 6-digit `code` from the user's authenticator app or a `recovery_code`. A wrong code returns `422`; an expired challenge, or too many wrong codes, returns `401` with `error_code: TWO_FACTOR_CHALLENGE_EXPIRED` and the login must start again. Users with several accounts verify once, then call `POST /auth/login/two-factor` again with the same challenge token and an `account_id`.\n\nTokens work the same once issued: two-factor authentication is only checked at login.\n\nIf an account requires two-factor authentication and the user has not set it up, authenticated endpoints return `403` with `error_code: TWO_FACTOR_SETUP_REQUIRED` until they do. `GET /users/me`, `GET /accounts`, the `/auth/*` endpoints and the `/users/me/two-factor/*` setup endpoints stay available.\n\n## Errors\n\nErrors return JSON with a `message`. Validation errors (`422`) also include an `errors` object keyed by field. Access errors include an `error_code`:\n\n| Status | `error_code` | Meaning |\n| --- | --- | --- |\n| `401` | — | Missing, invalid or expired token, or an invalid, expired or revoked API key |\n| `401` | `SESSION_REVOKED` | The session token was signed out everywhere, for example after a password reset |\n| `401` | `SSO_REQUIRED` | The user's organization requires single sign-on; sign in again through it |\n| `401` | `SSO_SESSION_EXPIRED` | A session started through single sign-on can't be refreshed; sign in again |\n| `401` | `INVITATION_PENDING` | `POST /auth/login` only: the user's only membership is an invitation they haven't accepted; they must open the invitation email |\n| `403` | `API_KEY_READ_ONLY` | A read-only API key tried to make a change |\n| `403` | `API_KEY_NOT_ALLOWED` | The endpoint can't be used with an API key |\n| `403` | `READ_ONLY_ROLE` | The user has view-only access to the account |\n| `403` | `PERMISSION_REQUIRED` | The user's role lacks a permission the endpoint needs (for example refunds or financial data) |\n| `403` | `ACCESS_RESTRICTED` | The user only has access to some organizers or events, and this isn't one of them |\n| `403` | `TWO_FACTOR_SETUP_REQUIRED` | The account requires two-factor authentication and the user hasn't set it up |\n| `403` | `ACCOUNT_PENDING_DELETION` | The account is scheduled for deletion |\n| `403` | `FEATURE_UNAVAILABLE` | The feature isn't available on this installation or plan |\n| `429` | — | Too many requests; wait for the number of seconds in the `Retry-After` header |\n\n## Rate limits\n\nManagement endpoints are rate limited per user, shared between the web app and all of that user's API keys. The default is 180 requests a minute; self-hosted installations can change it with `APP_API_RATE_LIMIT_PER_MINUTE`.\n\n## Stability\n\nThe API isn't versioned yet. Endpoints that accept API keys are the integration surface, and we keep them backward compatible: new endpoints, optional request fields and response fields can be added at any time, so ignore fields you don't recognise. Removing or renaming an endpoint or field, or changing its type or meaning, is a breaking change; it's avoided where possible and always called out in the release notes. Endpoints marked *Not available to API keys* serve the Hi.Events web app and may change without notice.\n\n## Outgoing webhooks\n\nWebhooks are configured per event or organizer (see the *Webhooks* endpoints) and deliver a `POST` request to your URL for each subscribed event:\n\n```json\n{\n \"event_type\": \"order.created\",\n \"event_sent_at\": \"2026-08-07T10:00:00+00:00\",\n \"payload\": { }\n}\n```\n\n`payload` matches the schema of the corresponding resource (see the *Schemas* section):\n\n| Events | Payload schema |\n| --- | --- |\n| `order.created`, `order.updated`, `order.marked_as_paid`, `order.refunded`, `order.cancelled` | `OrderResource` |\n| `attendee.created`, `attendee.updated`, `attendee.cancelled` | `AttendeeResource` |\n| `product.created`, `product.updated`, `product.deleted` | `ProductResource` |\n| `event.created`, `event.updated`, `event.archived` | `EventResource` |\n| `checkin.created`, `checkin.deleted` | `AttendeeCheckInResource` |\n| `occurrence.cancelled` | `EventOccurrenceResource` |\n\n`email` on an order payload is `null` for box office sales made without a buyer email. `order.created` and `order.cancelled` additionally emit an `attendee.created` / `attendee.cancelled` webhook for each attendee on the order. Deliveries are signed: the `Signature` header contains an HMAC-SHA256 hash of the JSON body using your webhook's secret."
},
"security": [
{
"http": []
}
],
"paths": {
"/accounts/{accountId}": {
"get": {
"operationId": "accounts.getAccountAction",
"summary": "Get Account",
"tags": [
"Accounts"
],
"parameters": [
{
"name": "accountId",
"in": "path",
"required": true,
"description": "**Optional**",
"schema": {
"type": [
"integer",
"null"
],
"default": null
},
"x-optional": true
}
],
"responses": {
"200": {
"description": "`AccountResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AccountResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/affiliates": {
"post": {
"operationId": "affiliates.createAffiliateAction",
"summary": "Create Affiliate",
"tags": [
"Affiliates"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateUpdateAffiliateRequest"
}
}
}
},
"responses": {
"201": {
"description": "`AffiliateResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AffiliateResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"get": {
"operationId": "affiliates.getAffiliatesAction",
"summary": "Get Affiliates",
"tags": [
"Affiliates"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"default": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"default": 25
}
},
{
"name": "sort_by",
"in": "query",
"description": "Sortable fields are listed in the response `meta.allowed_sorts`.",
"schema": {
"type": "string"
}
},
{
"name": "sort_direction",
"in": "query",
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"name": "query",
"in": "query",
"description": "Search term used to filter the results.",
"schema": {
"type": "string"
}
},
{
"name": "filter_fields",
"in": "query",
"description": "Filters in the form `filter_fields[field][operator]=value`. Filterable fields are listed in the response `meta.allowed_filter_fields`.",
"style": "deepObject",
"schema": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"explode": true
}
],
"responses": {
"200": {
"description": "Paginated set of `AffiliateResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AffiliateResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/affiliates/{affiliateId}": {
"put": {
"operationId": "affiliates.updateAffiliateAction",
"summary": "Update Affiliate",
"tags": [
"Affiliates"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "affiliateId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAffiliateRequest"
}
}
}
},
"responses": {
"200": {
"description": "`AffiliateResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AffiliateResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"get": {
"operationId": "affiliates.getAffiliateAction",
"summary": "Get Affiliate",
"tags": [
"Affiliates"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "affiliateId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`AffiliateResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AffiliateResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"delete": {
"operationId": "affiliates.deleteAffiliateAction",
"summary": "Delete Affiliate",
"tags": [
"Affiliates"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "affiliateId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/affiliates/export": {
"post": {
"operationId": "affiliates.exportAffiliatesAction",
"summary": "Export Affiliates",
"tags": [
"Affiliates"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "File download",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/attendees": {
"post": {
"operationId": "attendees.createAttendeeAction",
"summary": "Create Attendee",
"tags": [
"Attendees"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateAttendeeRequest"
}
}
}
},
"responses": {
"201": {
"description": "`AttendeeResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AttendeeResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"get": {
"operationId": "attendees.getAttendeesAction",
"summary": "Get Attendees",
"tags": [
"Attendees"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Paginated set of `AttendeeResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AttendeeResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/attendees/{attendeeId}": {
"get": {
"operationId": "attendees.getAttendeeAction",
"summary": "Get Attendee",
"tags": [
"Attendees"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "attendeeId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`AttendeeResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AttendeeResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"description": ""
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"put": {
"operationId": "attendees.editAttendeeAction",
"summary": "Edit Attendee",
"tags": [
"Attendees"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "attendeeId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EditAttendeeRequest"
}
}
}
},
"responses": {
"200": {
"description": "`AttendeeResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AttendeeResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"patch": {
"operationId": "attendees.partialEditAttendeeAction",
"summary": "Partial Edit Attendee",
"tags": [
"Attendees"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "attendeeId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PartialEditAttendeeRequest"
}
}
}
},
"responses": {
"200": {
"description": "`AttendeeResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AttendeeResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/attendees/export": {
"post": {
"operationId": "attendees.exportAttendeesAction",
"summary": "Export Attendees",
"tags": [
"Attendees"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "File download",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/attendees/{attendeeId}/resend-ticket": {
"post": {
"operationId": "attendees.resendAttendeeTicketAction",
"summary": "Resend Attendee Ticket",
"tags": [
"Attendees"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "attendeeId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/attendees/{attendeePublicId}/check_in": {
"post": {
"operationId": "attendees.checkInAttendeeAction",
"description": "This endpoint only sets a legacy flag on the attendee. The check-in isn't recorded on a check-in list, so it doesn't appear in the dashboard, check-in counts or exports, and no `checkin.created` or `checkin.deleted` webhook is sent. Use a check-in list instead: get the list's `short_id` from `GET /events/{eventId}/check-in-lists` (every event has a default list), then check attendees in with `POST /public/check-in-lists/{checkInListShortId}/check-ins` and out with `DELETE /public/check-in-lists/{checkInListShortId}/check-ins/{checkInShortId}`.",
"summary": "Check In Attendee",
"deprecated": true,
"tags": [
"Attendees"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "attendeePublicId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CheckInAttendeeRequest"
}
}
}
},
"responses": {
"200": {
"description": "`AttendeeResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AttendeeResource"
}
},
"required": [
"data"
]
}
}
}
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/public/events/{eventId}/attendees/{attendeeShortId}": {
"get": {
"operationId": "attendees.getAttendeeActionPublic",
"summary": "Get Attendee (public)",
"tags": [
"Attendees"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "attendeeShortId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "`AttendeeResourcePublic`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AttendeeResourcePublic"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"description": ""
}
},
"security": []
}
},
"/events/{eventId}/box-offices": {
"post": {
"operationId": "actions.createBoxOfficeAction",
"summary": "Create Box Office",
"tags": [
"Box Office"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertBoxOfficeRequest"
}
}
}
},
"responses": {
"201": {
"description": "`BoxOfficeWithPinResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/BoxOfficeWithPinResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "Access denied",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"get": {
"operationId": "actions.getBoxOfficesAction",
"summary": "Get Box Offices",
"tags": [
"Box Office"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"default": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"default": 25
}
},
{
"name": "sort_by",
"in": "query",
"description": "Sortable fields are listed in the response `meta.allowed_sorts`.",
"schema": {
"type": "string"
}
},
{
"name": "sort_direction",
"in": "query",
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"name": "query",
"in": "query",
"description": "Search term used to filter the results.",
"schema": {
"type": "string"
}
},
{
"name": "filter_fields",
"in": "query",
"description": "Filters in the form `filter_fields[field][operator]=value`. Filterable fields are listed in the response `meta.allowed_filter_fields`.",
"style": "deepObject",
"schema": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"explode": true
}
],
"responses": {
"200": {
"description": "Paginated set of `BoxOfficeResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BoxOfficeResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/box-offices/{boxOfficeId}": {
"get": {
"operationId": "actions.getBoxOfficeAction",
"summary": "Get Box Office",
"tags": [
"Box Office"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "boxOfficeId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`BoxOfficeResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/BoxOfficeResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"put": {
"operationId": "actions.updateBoxOfficeAction",
"summary": "Update Box Office",
"tags": [
"Box Office"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "boxOfficeId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertBoxOfficeRequest"
}
}
}
},
"responses": {
"200": {
"description": "`BoxOfficeResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/BoxOfficeResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "Access denied",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"delete": {
"operationId": "actions.deleteBoxOfficeAction",
"summary": "Delete Box Office",
"tags": [
"Box Office"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "boxOfficeId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/box-offices/{boxOfficeId}/stats": {
"get": {
"operationId": "actions.getBoxOfficeStatsAction",
"summary": "Get Box Office Stats",
"tags": [
"Box Office"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "boxOfficeId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "from",
"in": "query",
"schema": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
{
"name": "to",
"in": "query",
"schema": {
"type": [
"string",
"null"
],
"format": "date-time"
}
}
],
"responses": {
"200": {
"description": "`BoxOfficeStatsResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/BoxOfficeStatsResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/box-offices/{boxOfficeId}/reset-pin": {
"post": {
"operationId": "actions.resetBoxOfficePinAction",
"summary": "Reset Box Office Pin",
"tags": [
"Box Office"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "boxOfficeId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`BoxOfficeWithPinResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/BoxOfficeWithPinResource"
}
},
"required": [
"data"
]
}
}
}
},
"403": {
"description": "Access denied",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/capacity-assignments": {
"post": {
"operationId": "capacityAssignments.createCapacityAssignmentAction",
"summary": "Create Capacity Assignment",
"tags": [
"Capacity Assignments"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertCapacityAssignmentRequest"
}
}
}
},
"responses": {
"200": {
"description": "`CapacityAssignmentResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CapacityAssignmentResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"get": {
"operationId": "capacityAssignments.getCapacityAssignmentsAction",
"summary": "Get Capacity Assignments",
"tags": [
"Capacity Assignments"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"default": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"default": 25
}
},
{
"name": "sort_by",
"in": "query",
"description": "Sortable fields are listed in the response `meta.allowed_sorts`.",
"schema": {
"type": "string"
}
},
{
"name": "sort_direction",
"in": "query",
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"name": "query",
"in": "query",
"description": "Search term used to filter the results.",
"schema": {
"type": "string"
}
},
{
"name": "filter_fields",
"in": "query",
"description": "Filters in the form `filter_fields[field][operator]=value`. Filterable fields are listed in the response `meta.allowed_filter_fields`.",
"style": "deepObject",
"schema": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"explode": true
}
],
"responses": {
"200": {
"description": "Array of `CapacityAssignmentResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CapacityAssignmentResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/capacity-assignments/{capacityAssignmentId}": {
"get": {
"operationId": "capacityAssignments.getCapacityAssignmentAction",
"summary": "Get Capacity Assignment",
"tags": [
"Capacity Assignments"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "capacityAssignmentId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`CapacityAssignmentResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CapacityAssignmentResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"put": {
"operationId": "capacityAssignments.updateCapacityAssignmentAction",
"summary": "Update Capacity Assignment",
"tags": [
"Capacity Assignments"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "capacityAssignmentId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertCapacityAssignmentRequest"
}
}
}
},
"responses": {
"200": {
"description": "`CapacityAssignmentResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CapacityAssignmentResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"delete": {
"operationId": "capacityAssignments.deleteCapacityAssignmentAction",
"summary": "Delete Capacity Assignment",
"tags": [
"Capacity Assignments"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "capacityAssignmentId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/check-in-lists": {
"post": {
"operationId": "checkInLists.createCheckInListAction",
"summary": "Create Check In List",
"tags": [
"Check In Lists"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertCheckInListRequest"
}
}
}
},
"responses": {
"200": {
"description": "`CheckInListResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CheckInListResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"get": {
"operationId": "checkInLists.getCheckInListsAction",
"summary": "Get Check In Lists",
"tags": [
"Check In Lists"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"default": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"default": 25
}
},
{
"name": "sort_by",
"in": "query",
"description": "Sortable fields are listed in the response `meta.allowed_sorts`.",
"schema": {
"type": "string"
}
},
{
"name": "sort_direction",
"in": "query",
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"name": "query",
"in": "query",
"description": "Search term used to filter the results.",
"schema": {
"type": "string"
}
},
{
"name": "filter_fields",
"in": "query",
"description": "Filters in the form `filter_fields[field][operator]=value`. Filterable fields are listed in the response `meta.allowed_filter_fields`.",
"style": "deepObject",
"schema": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"explode": true
}
],
"responses": {
"200": {
"description": "Paginated set of `CheckInListResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CheckInListResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/check-in-lists/{checkInListId}": {
"get": {
"operationId": "checkInLists.getCheckInListAction",
"summary": "Get Check In List",
"tags": [
"Check In Lists"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "checkInListId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`CheckInListResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CheckInListResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"put": {
"operationId": "checkInLists.updateCheckInListAction",
"summary": "Update Check In List",
"tags": [
"Check In Lists"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "checkInListId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertCheckInListRequest"
}
}
}
},
"responses": {
"200": {
"description": "`CheckInListResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CheckInListResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"delete": {
"operationId": "checkInLists.deleteCheckInListAction",
"summary": "Delete Check In List",
"tags": [
"Check In Lists"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "checkInListId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/public/check-in-lists/{checkInListShortId}": {
"get": {
"operationId": "public.getCheckInListPublicAction",
"summary": "Get Check In List (public)",
"tags": [
"Check In Lists / Public"
],
"parameters": [
{
"name": "checkInListShortId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "`CheckInListResourcePublic`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CheckInListResourcePublic"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
},
"security": []
}
},
"/public/check-in-lists/{checkInListShortId}/stats": {
"get": {
"operationId": "public.getCheckInListStatsPublicAction",
"summary": "Get Check In List Stats (public)",
"tags": [
"Check In Lists / Public"
],
"parameters": [
{
"name": "checkInListShortId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "event_occurrence_id",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "`CheckInListStatsPublicResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/CheckInListStatsPublicResource"
}
},
"required": [
"data"
]
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
},
"security": []
}
},
"/public/check-in-lists/{checkInListShortId}/attendees": {
"get": {
"operationId": "public.getCheckInListAttendeesPublicAction",
"summary": "Get Check In List Attendees (public)",
"tags": [
"Check In Lists / Public"
],
"parameters": [
{
"name": "checkInListShortId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Array of `AttendeeWithCheckInPublicResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AttendeeWithCheckInPublicResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
},
"security": []
}
},
"/public/check-in-lists/{shortId}/attendees/{attendeePublicId}": {
"get": {
"operationId": "public.getCheckInListAttendeePublicAction",
"summary": "Get Check In List Attendee (public)",
"tags": [
"Check In Lists / Public"
],
"parameters": [
{
"name": "shortId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "attendeePublicId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "`AttendeeWithCheckInPublicResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AttendeeWithCheckInPublicResource"
}
},
"required": [
"data"
]
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
},
"security": []
}
},
"/public/check-in-lists/{checkInListShortId}/attendees/{attendeePublicId}/detail": {
"get": {
"operationId": "public.getCheckInListAttendeeDetailPublicAction",
"summary": "Get Check In List Attendee Detail (public)",
"tags": [
"Check In Lists / Public"
],
"parameters": [
{
"name": "checkInListShortId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "attendeePublicId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "`AttendeeDetailPublicResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AttendeeDetailPublicResource"
}
},
"required": [
"data"
]
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
},
"security": []
}
},
"/public/check-in-lists/{checkInListUuid}/check-ins": {
"post": {
"operationId": "public.createAttendeeCheckInPublicAction",
"summary": "Create Attendee Check In (public)",
"tags": [
"Check In Lists / Public"
],
"parameters": [
{
"name": "checkInListUuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateAttendeeCheckInPublicRequest"
}
}
}
},
"responses": {
"200": {
"description": "Array of `AttendeeCheckInPublicResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AttendeeCheckInPublicResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
},
"security": []
}
},
"/public/check-in-lists/{checkInListShortId}/check-ins/{checkInShortId}": {
"delete": {
"operationId": "public.deleteAttendeeCheckInPublicAction",
"summary": "Delete Attendee Check In (public)",
"tags": [
"Check In Lists / Public"
],
"parameters": [
{
"name": "checkInListShortId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "checkInShortId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
},
"security": []
}
},
"/public/color-themes": {
"get": {
"operationId": "common.getColorThemesAction",
"summary": "Get Color Themes (public)",
"tags": [
"Common"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {}
}
},
"required": [
"data"
]
}
}
}
}
},
"security": []
}
},
"/organizers/{organizerId}/email-templates": {
"get": {
"operationId": "emailTemplates.getOrganizerEmailTemplatesAction",
"summary": "Get Organizer Email Templates",
"tags": [
"Email Templates"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "template_type",
"in": "query",
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/EmailTemplateType"
},
{
"type": "null"
}
]
}
},
{
"name": "include_inactive",
"in": "query",
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
}
}
],
"responses": {
"200": {
"description": "Array of `EmailTemplateResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailTemplateResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"post": {
"operationId": "emailTemplates.createOrganizerEmailTemplateAction",
"summary": "Create Organizer Email Template",
"tags": [
"Email Templates"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"201": {
"description": "`EmailTemplateResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EmailTemplateResource"
}
},
"required": [
"data"
]
}
}
}
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/email-templates/defaults": {
"get": {
"operationId": "emailTemplates.getDefaultEmailTemplateAction",
"summary": "Get Default Email Template",
"tags": [
"Email Templates"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/organizers/{organizerId}/email-templates/{templateId}": {
"put": {
"operationId": "emailTemplates.updateOrganizerEmailTemplateAction",
"summary": "Update Organizer Email Template",
"tags": [
"Email Templates"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`EmailTemplateResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EmailTemplateResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"delete": {
"operationId": "emailTemplates.deleteOrganizerEmailTemplateAction",
"summary": "Delete Organizer Email Template",
"tags": [
"Email Templates"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/organizers/{organizerId}/email-templates/preview": {
"post": {
"operationId": "emailTemplates.previewOrganizerEmailTemplateAction",
"summary": "Preview Organizer Email Template",
"tags": [
"Email Templates"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"body": {
"type": "string"
},
"context": {
"type": "object",
"properties": {
"event": {
"type": "object",
"properties": {
"title": {
"type": "string",
"const": "Summer Music Festival 2024"
},
"date": {
"type": "string",
"const": "April 25, 2029"
},
"time": {
"type": "string",
"const": "7:00 PM"
},
"end_date": {
"type": "string",
"const": "April 26, 2029"
},
"end_time": {
"type": "string",
"const": "11:00 PM"
},
"full_address": {
"type": "string",
"const": "3 Arena, North Wall Quay, Dublin 1, Ireland"
},
"description": {
"type": "string",
"const": "Join us for an unforgettable evening of live music featuring top artists from around the world."
},
"timezone": {
"type": "string",
"const": "UTC"
},
"location_details": {
"type": "object",
"properties": {
"venue_name": {
"type": "string",
"const": "3 Arena"
},
"address_line_1": {
"type": "string",
"const": "North Wall Quay"
},
"address_line_2": {
"type": "string"
},
"city": {
"type": "string",
"const": "Dublin"
},
"state_or_region": {
"type": "string",
"const": "Dublin 1"
},
"zip_or_postal_code": {
"type": "string",
"const": "D01 T0X4"
},
"country": {
"type": "string",
"const": "IE"
}
},
"required": [
"venue_name",
"address_line_1",
"address_line_2",
"city",
"state_or_region",
"zip_or_postal_code",
"country"
]
},
"url": {
"type": "string",
"const": "https://example.com/event/123/summer-fest"
}
},
"required": [
"title",
"date",
"time",
"end_date",
"end_time",
"full_address",
"description",
"timezone",
"location_details",
"url"
]
},
"order": {
"type": "object",
"properties": {
"url": {
"type": "string",
"const": "https://example.com/order/ABC123"
},
"number": {
"type": "string"
},
"total": {
"type": "string",
"const": "$150.00"
},
"date": {
"type": "string",
"const": "January 10, 2024"
},
"first_name": {
"type": "string",
"const": "John"
},
"last_name": {
"type": "string",
"const": "Smith"
},
"email": {
"type": "string",
"const": "[email protected]"
},
"is_awaiting_offline_payment": {
"type": "boolean"
},
"is_offline_payment": {
"type": "boolean"
},
"payment_reference": {
"type": "string"
},
"seats": {
"type": "string",
"const": "Stalls · C-14, Stalls · C-15"
},
"locale": {
"type": "string"
},
"currency": {
"type": "string",
"const": "USD"
}
},
"required": [
"url",
"number",
"total",
"date",
"first_name",
"last_name",
"email",
"is_awaiting_offline_payment",
"is_offline_payment",
"payment_reference",
"seats",
"locale",
"currency"
]
},
"organizer": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "ACME Events Inc."
},
"email": {
"type": "string",
"const": "[email protected]"
}
},
"required": [
"name",
"email"
]
},
"settings": {
"type": "object",
"properties": {
"support_email": {
"type": "string",
"const": "[email protected]"
},
"offline_payment_instructions": {
"type": "string",
"const": "Please transfer the total amount to the following bank account within 5 business days."
},
"post_checkout_message": {
"type": "string",
"const": "Thank you for your purchase! We look forward to seeing you at the event."
}
},
"required": [
"support_email",
"offline_payment_instructions",
"post_checkout_message"
]
},
"occurrence": {
"type": "object",
"properties": {
"start_date": {
"type": "string",
"const": "April 25, 2029"
},
"start_time": {
"type": "string",
"const": "7:00 PM"
},
"end_date": {
"type": "string",
"const": "April 26, 2029"
},
"end_time": {
"type": "string",
"const": "11:00 PM"
},
"label": {
"type": "string",
"const": "Session A"
}
},
"required": [
"start_date",
"start_time",
"end_date",
"end_time",
"label"
]
},
"lineup": {
"type": "object",
"properties": {
"heading": {
"type": "string",
"const": "Lineup"
},
"names": {
"type": "array",
"prefixItems": [
{
"type": "string",
"const": "Velvet Harbour"
},
{
"type": "string",
"const": "The Northern Arcs"
},
{
"type": "string",
"const": "Mira Solenne"
}
],
"minItems": 3,
"maxItems": 3,
"items": false
},
"slots": {
"type": "array",
"prefixItems": [
{
"type": "object",
"properties": {
"time": {
"type": "string",
"const": "Fri 25 Apr · 9:30 PM"
},
"title": {
"type": "string",
"const": "Velvet Harbour"
},
"stage": {
"type": "string",
"const": "Main Stage"
}
},
"required": [
"time",
"title",
"stage"
]
},
{
"type": "object",
"properties": {
"time": {
"type": "string",
"const": "Sat 26 Apr · 10:00 PM"
},
"title": {
"type": "string",
"const": "The Northern Arcs"
},
"stage": {
"type": "string",
"const": "Main Stage"
}
},
"required": [
"time",
"title",
"stage"
]
}
],
"minItems": 2,
"maxItems": 2,
"items": false
},
"url": {
"type": "string",
"const": "https://example.com/event/123/summer-fest#schedule"
}
},
"required": [
"heading",
"names",
"slots",
"url"
]
},
"event_location": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"is_online": {
"type": "boolean"
},
"online_connection_details": {
"type": "null"
},
"name": {
"type": "string",
"const": "3 Arena"
},
"label": {
"type": "null"
},
"formatted_address": {
"type": "string",
"const": "3 Arena, North Wall Quay, Dublin 1, Ireland"
},
"latitude": {
"type": "number",
"const": 53.3478
},
"longitude": {
"type": "string"
},
"structured_address": {
"type": "object",
"properties": {
"venue_name": {
"type": "string",
"const": "3 Arena"
},
"address_line_1": {
"type": "string",
"const": "North Wall Quay"
},
"address_line_2": {
"type": "string"
},
"city": {
"type": "string",
"const": "Dublin"
},
"state_or_region": {
"type": "string",
"const": "Dublin 1"
},
"zip_or_postal_code": {
"type": "string",
"const": "D01 T0X4"
},
"country": {
"type": "string",
"const": "IE"
}
},
"required": [
"venue_name",
"address_line_1",
"address_line_2",
"city",
"state_or_region",
"zip_or_postal_code",
"country"
]
}
},
"required": [
"type",
"is_online",
"online_connection_details",
"name",
"label",
"formatted_address",
"latitude",
"longitude",
"structured_address"
]
},
"attendee": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "John Smith"
},
"email": {
"type": "string",
"const": "[email protected]"
},
"seat": {
"type": "string",
"const": "Stalls · C-14"
}
},
"required": [
"name",
"email",
"seat"
]
},
"ticket": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "VIP Pass"
},
"price": {
"type": "string",
"const": "$75.00"
},
"url": {
"type": "string",
"const": "https://example.com/ticket/XYZ789"
}
},
"required": [
"name",
"price",
"url"
]
},
"cancellation": {
"type": "object",
"properties": {
"refund_issued": {
"type": "boolean"
}
},
"required": [
"refund_issued"
]
}
},
"required": [
"event",
"order",
"organizer",
"settings",
"occurrence",
"lineup",
"event_location",
"attendee",
"ticket",
"cancellation"
]
}
},
"required": [
"subject",
"body",
"context"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/email-templates/tokens/{templateType}": {
"get": {
"operationId": "emailTemplates.getAvailableTokensAction",
"summary": "Get Available Tokens",
"tags": [
"Email Templates"
],
"parameters": [
{
"name": "templateType",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"tokens": {
"anyOf": [
{
"type": "array",
"prefixItems": [
{
"type": "object",
"properties": {
"token": {
"type": "string",
"const": "{{ lineup.url }}"
},
"description": {
"type": "string",
"const": "Link to the full schedule on the event page"
},
"example": {
"type": "string",
"const": "https://example.com/event/123/summer-fest#schedule"
}
},
"required": [
"token",
"description",
"example"
]
}
],
"minItems": 1,
"maxItems": 1,
"items": false
},
{
"type": "array",
"prefixItems": [
{
"type": "object",
"properties": {
"token": {
"type": "string",
"const": "{{ event.url }}"
},
"description": {
"type": "string",
"const": "Link to the event homepage"
},
"example": {
"type": "string",
"const": "https://example.com/event/123/summer-fest"
}
},
"required": [
"token",
"description",
"example"
]
}
],
"minItems": 1,
"maxItems": 1,
"items": false
}
]
}
},
"required": [
"tokens"
]
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"const": "Invalid template type"
}
},
"required": [
"error"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/email-templates": {
"get": {
"operationId": "emailTemplates.getEventEmailTemplatesAction",
"summary": "Get Event Email Templates",
"tags": [
"Email Templates"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "template_type",
"in": "query",
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/EmailTemplateType"
},
{
"type": "null"
}
]
}
},
{
"name": "include_inactive",
"in": "query",
"schema": {
"type": "string",
"enum": [
"true",
"false"
]
}
}
],
"responses": {
"200": {
"description": "Array of `EmailTemplateResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailTemplateResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"post": {
"operationId": "emailTemplates.createEventEmailTemplateAction",
"summary": "Create Event Email Template",
"tags": [
"Email Templates"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"201": {
"description": "`EmailTemplateResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EmailTemplateResource"
}
},
"required": [
"data"
]
}
}
}
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/email-templates/{templateId}": {
"put": {
"operationId": "emailTemplates.updateEventEmailTemplateAction",
"summary": "Update Event Email Template",
"tags": [
"Email Templates"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`EmailTemplateResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EmailTemplateResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"delete": {
"operationId": "emailTemplates.deleteEventEmailTemplateAction",
"summary": "Delete Event Email Template",
"tags": [
"Email Templates"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "templateId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/email-templates/preview": {
"post": {
"operationId": "emailTemplates.previewEventEmailTemplateAction",
"summary": "Preview Event Email Template",
"tags": [
"Email Templates"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"subject": {
"type": "string"
},
"body": {
"type": "string"
},
"context": {
"type": "object",
"properties": {
"event": {
"type": "object",
"properties": {
"title": {
"type": "string",
"const": "Summer Music Festival 2024"
},
"date": {
"type": "string",
"const": "April 25, 2029"
},
"time": {
"type": "string",
"const": "7:00 PM"
},
"end_date": {
"type": "string",
"const": "April 26, 2029"
},
"end_time": {
"type": "string",
"const": "11:00 PM"
},
"full_address": {
"type": "string",
"const": "3 Arena, North Wall Quay, Dublin 1, Ireland"
},
"description": {
"type": "string",
"const": "Join us for an unforgettable evening of live music featuring top artists from around the world."
},
"timezone": {
"type": "string",
"const": "UTC"
},
"location_details": {
"type": "object",
"properties": {
"venue_name": {
"type": "string",
"const": "3 Arena"
},
"address_line_1": {
"type": "string",
"const": "North Wall Quay"
},
"address_line_2": {
"type": "string"
},
"city": {
"type": "string",
"const": "Dublin"
},
"state_or_region": {
"type": "string",
"const": "Dublin 1"
},
"zip_or_postal_code": {
"type": "string",
"const": "D01 T0X4"
},
"country": {
"type": "string",
"const": "IE"
}
},
"required": [
"venue_name",
"address_line_1",
"address_line_2",
"city",
"state_or_region",
"zip_or_postal_code",
"country"
]
},
"url": {
"type": "string",
"const": "https://example.com/event/123/summer-fest"
}
},
"required": [
"title",
"date",
"time",
"end_date",
"end_time",
"full_address",
"description",
"timezone",
"location_details",
"url"
]
},
"order": {
"type": "object",
"properties": {
"url": {
"type": "string",
"const": "https://example.com/order/ABC123"
},
"number": {
"type": "string"
},
"total": {
"type": "string",
"const": "$150.00"
},
"date": {
"type": "string",
"const": "January 10, 2024"
},
"first_name": {
"type": "string",
"const": "John"
},
"last_name": {
"type": "string",
"const": "Smith"
},
"email": {
"type": "string",
"const": "[email protected]"
},
"is_awaiting_offline_payment": {
"type": "boolean"
},
"is_offline_payment": {
"type": "boolean"
},
"payment_reference": {
"type": "string"
},
"seats": {
"type": "string",
"const": "Stalls · C-14, Stalls · C-15"
},
"locale": {
"type": "string"
},
"currency": {
"type": "string",
"const": "USD"
}
},
"required": [
"url",
"number",
"total",
"date",
"first_name",
"last_name",
"email",
"is_awaiting_offline_payment",
"is_offline_payment",
"payment_reference",
"seats",
"locale",
"currency"
]
},
"organizer": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "ACME Events Inc."
},
"email": {
"type": "string",
"const": "[email protected]"
}
},
"required": [
"name",
"email"
]
},
"settings": {
"type": "object",
"properties": {
"support_email": {
"type": "string",
"const": "[email protected]"
},
"offline_payment_instructions": {
"type": "string",
"const": "Please transfer the total amount to the following bank account within 5 business days."
},
"post_checkout_message": {
"type": "string",
"const": "Thank you for your purchase! We look forward to seeing you at the event."
}
},
"required": [
"support_email",
"offline_payment_instructions",
"post_checkout_message"
]
},
"occurrence": {
"type": "object",
"properties": {
"start_date": {
"type": "string",
"const": "April 25, 2029"
},
"start_time": {
"type": "string",
"const": "7:00 PM"
},
"end_date": {
"type": "string",
"const": "April 26, 2029"
},
"end_time": {
"type": "string",
"const": "11:00 PM"
},
"label": {
"type": "string",
"const": "Session A"
}
},
"required": [
"start_date",
"start_time",
"end_date",
"end_time",
"label"
]
},
"lineup": {
"type": "object",
"properties": {
"heading": {
"type": "string",
"const": "Lineup"
},
"names": {
"type": "array",
"prefixItems": [
{
"type": "string",
"const": "Velvet Harbour"
},
{
"type": "string",
"const": "The Northern Arcs"
},
{
"type": "string",
"const": "Mira Solenne"
}
],
"minItems": 3,
"maxItems": 3,
"items": false
},
"slots": {
"type": "array",
"prefixItems": [
{
"type": "object",
"properties": {
"time": {
"type": "string",
"const": "Fri 25 Apr · 9:30 PM"
},
"title": {
"type": "string",
"const": "Velvet Harbour"
},
"stage": {
"type": "string",
"const": "Main Stage"
}
},
"required": [
"time",
"title",
"stage"
]
},
{
"type": "object",
"properties": {
"time": {
"type": "string",
"const": "Sat 26 Apr · 10:00 PM"
},
"title": {
"type": "string",
"const": "The Northern Arcs"
},
"stage": {
"type": "string",
"const": "Main Stage"
}
},
"required": [
"time",
"title",
"stage"
]
}
],
"minItems": 2,
"maxItems": 2,
"items": false
},
"url": {
"type": "string",
"const": "https://example.com/event/123/summer-fest#schedule"
}
},
"required": [
"heading",
"names",
"slots",
"url"
]
},
"event_location": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"is_online": {
"type": "boolean"
},
"online_connection_details": {
"type": "null"
},
"name": {
"type": "string",
"const": "3 Arena"
},
"label": {
"type": "null"
},
"formatted_address": {
"type": "string",
"const": "3 Arena, North Wall Quay, Dublin 1, Ireland"
},
"latitude": {
"type": "number",
"const": 53.3478
},
"longitude": {
"type": "string"
},
"structured_address": {
"type": "object",
"properties": {
"venue_name": {
"type": "string",
"const": "3 Arena"
},
"address_line_1": {
"type": "string",
"const": "North Wall Quay"
},
"address_line_2": {
"type": "string"
},
"city": {
"type": "string",
"const": "Dublin"
},
"state_or_region": {
"type": "string",
"const": "Dublin 1"
},
"zip_or_postal_code": {
"type": "string",
"const": "D01 T0X4"
},
"country": {
"type": "string",
"const": "IE"
}
},
"required": [
"venue_name",
"address_line_1",
"address_line_2",
"city",
"state_or_region",
"zip_or_postal_code",
"country"
]
}
},
"required": [
"type",
"is_online",
"online_connection_details",
"name",
"label",
"formatted_address",
"latitude",
"longitude",
"structured_address"
]
},
"attendee": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "John Smith"
},
"email": {
"type": "string",
"const": "[email protected]"
},
"seat": {
"type": "string",
"const": "Stalls · C-14"
}
},
"required": [
"name",
"email",
"seat"
]
},
"ticket": {
"type": "object",
"properties": {
"name": {
"type": "string",
"const": "VIP Pass"
},
"price": {
"type": "string",
"const": "$75.00"
},
"url": {
"type": "string",
"const": "https://example.com/ticket/XYZ789"
}
},
"required": [
"name",
"price",
"url"
]
},
"cancellation": {
"type": "object",
"properties": {
"refund_issued": {
"type": "boolean"
}
},
"required": [
"refund_issued"
]
}
},
"required": [
"event",
"order",
"organizer",
"settings",
"occurrence",
"lineup",
"event_location",
"attendee",
"ticket",
"cancellation"
]
}
},
"required": [
"subject",
"body",
"context"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/occurrences/generate": {
"post": {
"operationId": "eventOccurrences.generateOccurrencesAction",
"summary": "Generate Occurrences",
"tags": [
"Event Occurrences"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GenerateOccurrencesRequest"
}
}
}
},
"responses": {
"202": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"enum": [
"Job is still in progress",
"Job completed successfully",
"Export file not found",
"Job failed",
"Job not found"
]
},
"status": {
"type": "string"
},
"job_uuid": {
"type": "string"
}
},
"required": [
"message",
"status",
"job_uuid"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/occurrences/generate/status": {
"get": {
"operationId": "eventOccurrences.getOccurrenceGenerationStatusAction",
"summary": "Get Occurrence Generation Status",
"tags": [
"Event Occurrences"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"enum": [
"Job is still in progress",
"Job completed successfully",
"Export file not found",
"Job failed",
"Job not found"
]
},
"status": {
"type": "string"
},
"job_uuid": {
"type": "string"
}
},
"required": [
"message",
"status",
"job_uuid"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/occurrences/bulk-update": {
"post": {
"operationId": "eventOccurrences.bulkUpdateOccurrencesAction",
"summary": "Bulk Update Occurrences",
"tags": [
"Event Occurrences"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkUpdateOccurrencesRequest"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"updated_count": {
"type": "integer"
},
"updated_ids": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "array",
"items": {
"type": "integer"
}
}
]
}
},
"required": [
"updated_count",
"updated_ids"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/occurrences": {
"post": {
"operationId": "eventOccurrences.createEventOccurrenceAction",
"summary": "Create Event Occurrence",
"tags": [
"Event Occurrences"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertEventOccurrenceRequest"
}
}
}
},
"responses": {
"200": {
"description": "`EventOccurrenceResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EventOccurrenceResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"get": {
"operationId": "eventOccurrences.getEventOccurrencesAction",
"summary": "Get Event Occurrences",
"tags": [
"Event Occurrences"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "include_stats",
"in": "query",
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"200": {
"description": "Paginated set of `EventOccurrenceResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventOccurrenceResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/occurrences/{occurrenceId}": {
"get": {
"operationId": "eventOccurrences.getEventOccurrenceAction",
"summary": "Get Event Occurrence",
"tags": [
"Event Occurrences"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "occurrenceId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`EventOccurrenceResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EventOccurrenceResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"put": {
"operationId": "eventOccurrences.updateEventOccurrenceAction",
"summary": "Update Event Occurrence",
"tags": [
"Event Occurrences"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "occurrenceId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertEventOccurrenceRequest"
}
}
}
},
"responses": {
"200": {
"description": "`EventOccurrenceResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EventOccurrenceResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"delete": {
"operationId": "eventOccurrences.deleteEventOccurrenceAction",
"summary": "Delete Event Occurrence",
"tags": [
"Event Occurrences"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "occurrenceId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/occurrences/{occurrenceId}/cancel": {
"post": {
"operationId": "eventOccurrences.cancelOccurrenceAction",
"summary": "Cancel Occurrence",
"tags": [
"Event Occurrences"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "occurrenceId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CancelOccurrenceRequest"
}
}
}
},
"responses": {
"200": {
"description": "`EventOccurrenceResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EventOccurrenceResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/occurrences/{occurrenceId}/reactivate": {
"post": {
"operationId": "eventOccurrences.reactivateOccurrenceAction",
"summary": "Reactivate Occurrence",
"tags": [
"Event Occurrences"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "occurrenceId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`EventOccurrenceResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EventOccurrenceResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/occurrences/{occurrenceId}/price-overrides": {
"put": {
"operationId": "eventOccurrences.upsertPriceOverrideAction",
"summary": "Upsert Price Override",
"tags": [
"Event Occurrences"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "occurrenceId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertPriceOverrideRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ProductPriceOccurrenceOverrideResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProductPriceOccurrenceOverrideResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"get": {
"operationId": "eventOccurrences.getPriceOverridesAction",
"summary": "Get Price Overrides",
"tags": [
"Event Occurrences"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "occurrenceId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Array of `ProductPriceOccurrenceOverrideResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductPriceOccurrenceOverrideResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/occurrences/{occurrenceId}/price-overrides/{overrideId}": {
"delete": {
"operationId": "eventOccurrences.deletePriceOverrideAction",
"summary": "Delete Price Override",
"tags": [
"Event Occurrences"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "occurrenceId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "overrideId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/occurrences/{occurrenceId}/product-visibility": {
"get": {
"operationId": "eventOccurrences.getProductVisibilityAction",
"summary": "Get Product Visibility",
"tags": [
"Event Occurrences"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "occurrenceId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Array of `ProductOccurrenceVisibilityResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductOccurrenceVisibilityResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"put": {
"operationId": "eventOccurrences.updateProductVisibilityAction",
"summary": "Update Product Visibility",
"tags": [
"Event Occurrences"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "occurrenceId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateProductVisibilityRequest"
}
}
}
},
"responses": {
"200": {
"description": "Array of `ProductOccurrenceVisibilityResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductOccurrenceVisibilityResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/occurrences/{occurrenceId}/product-availability": {
"get": {
"operationId": "eventOccurrences.getOccurrenceProductAvailabilityAction",
"summary": "Get Occurrence Product Availability",
"tags": [
"Event Occurrences"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "occurrenceId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Array of `OccurrenceProductAvailabilityResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OccurrenceProductAvailabilityResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/public/events/{eventId}/occurrences": {
"get": {
"operationId": "eventOccurrences.getEventOccurrencesPublicAction",
"summary": "Get Event Occurrences (public)",
"tags": [
"Event Occurrences"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "start_date_from",
"in": "query",
"description": "Only return occurrences starting on or after this date (ISO 8601).",
"schema": {
"type": "string"
}
},
{
"name": "start_date_to",
"in": "query",
"description": "Only return occurrences starting on or before this date (ISO 8601).",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventOccurrenceResourcePublic"
}
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"description": ""
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"429": {
"description": "Too many requests. Retry once the rate limit window resets.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
},
"security": []
}
},
"/events/{eventId}/settings": {
"get": {
"operationId": "eventSettings.getEventSettingsAction",
"summary": "Get Event Settings",
"tags": [
"Event Settings"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`EventSettingsResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EventSettingsResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"description": ""
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"put": {
"operationId": "eventSettings.editEventSettingsAction",
"summary": "Edit Event Settings",
"tags": [
"Event Settings"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateEventSettingsRequest"
}
}
}
},
"responses": {
"200": {
"description": "`EventSettingsResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EventSettingsResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"patch": {
"operationId": "eventSettings.partialEditEventSettingsAction",
"summary": "Partial Edit Event Settings",
"tags": [
"Event Settings"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateEventSettingsRequest"
}
}
}
},
"responses": {
"200": {
"description": "`EventSettingsResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EventSettingsResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/settings/platform-fee-preview": {
"get": {
"operationId": "eventSettings.getPlatformFeePreviewAction",
"summary": "Get Platform Fee Preview",
"tags": [
"Event Settings"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "price",
"in": "query",
"required": true,
"schema": {
"type": "number",
"minimum": 0
}
}
],
"responses": {
"200": {
"description": "`PlatformFeePreviewResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PlatformFeePreviewResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events": {
"post": {
"operationId": "events.createEventAction",
"summary": "Create Event",
"tags": [
"Events"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateEventRequest"
}
}
}
},
"responses": {
"200": {
"description": "`EventResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EventResource"
}
},
"required": [
"data"
]
}
}
}
},
"403": {
"description": "Access denied",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
}
}
},
"get": {
"operationId": "events.getEventsAction",
"summary": "Get Events",
"tags": [
"Events"
],
"parameters": [
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"default": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"default": 25
}
},
{
"name": "sort_by",
"in": "query",
"description": "Sortable fields are listed in the response `meta.allowed_sorts`.",
"schema": {
"type": "string"
}
},
{
"name": "sort_direction",
"in": "query",
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"name": "query",
"in": "query",
"description": "Search term used to filter the results.",
"schema": {
"type": "string"
}
},
{
"name": "filter_fields",
"in": "query",
"description": "Filters in the form `filter_fields[field][operator]=value`. Filterable fields are listed in the response `meta.allowed_filter_fields`.",
"style": "deepObject",
"schema": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"explode": true
}
],
"responses": {
"200": {
"description": "Paginated set of `EventResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}": {
"get": {
"operationId": "events.getEventAction",
"summary": "Get Event",
"tags": [
"Events"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`EventResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EventResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"put": {
"operationId": "events.updateEventAction",
"summary": "Update Event",
"tags": [
"Events"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateEventRequest"
}
}
}
},
"responses": {
"200": {
"description": "`EventResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EventResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"delete": {
"operationId": "events.deleteEventAction",
"summary": "Delete Event",
"tags": [
"Events"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/event-location": {
"patch": {
"operationId": "events.updateEventLocationAction",
"summary": "Update Event Location",
"tags": [
"Events"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateEventLocationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`EventResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EventResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/status": {
"put": {
"operationId": "events.updateEventStatusAction",
"summary": "Update Event Status",
"tags": [
"Events"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateEventStatusRequest"
}
}
}
},
"responses": {
"200": {
"description": "`EventResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EventResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/type": {
"put": {
"operationId": "events.updateEventTypeAction",
"summary": "Update Event Type",
"tags": [
"Events"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateEventTypeRequest"
}
}
}
},
"responses": {
"200": {
"description": "`EventResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EventResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/deletion-status": {
"get": {
"operationId": "events.getEventDeletionStatusAction",
"summary": "Get Event Deletion Status",
"tags": [
"Events"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"can_delete": {
"type": "boolean"
},
"reason": {
"type": [
"string",
"null"
],
"enum": [
"This event has completed orders. Please cancel or refund all orders before deleting.",
null
]
}
},
"required": [
"can_delete",
"reason"
]
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/duplicate": {
"post": {
"operationId": "events.duplicateEventAction",
"summary": "Duplicate Event",
"tags": [
"Events"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DuplicateEventRequest"
}
}
}
},
"responses": {
"200": {
"description": "`EventResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EventResource"
}
},
"required": [
"data"
]
}
}
}
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"403": {
"description": "Access denied",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/public/events/{eventId}": {
"get": {
"operationId": "events.getEventPublicAction.getPublicEventsEventId",
"summary": "Get Event (public)",
"tags": [
"Events"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "promo_code",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "product_ids",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "product_category_ids",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "`EventResourcePublic`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EventResourcePublic"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"description": ""
}
},
"security": []
}
},
"/public/organizers/{organizerId}/events": {
"get": {
"operationId": "events.getOrganizerEventsPublicAction",
"summary": "Get Organizer Events (public)",
"tags": [
"Events"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"default": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"default": 25
}
},
{
"name": "sort_by",
"in": "query",
"description": "Sortable fields are listed in the response `meta.allowed_sorts`.",
"schema": {
"type": "string"
}
},
{
"name": "sort_direction",
"in": "query",
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"name": "query",
"in": "query",
"description": "Search term used to filter the results.",
"schema": {
"type": "string"
}
},
{
"name": "filter_fields",
"in": "query",
"description": "Filters in the form `filter_fields[field][operator]=value`. Filterable fields are listed in the response `meta.allowed_filter_fields`.",
"style": "deepObject",
"schema": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"explode": true
}
],
"responses": {
"200": {
"description": "Paginated set of `EventResourcePublic`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventResourcePublic"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
},
"security": []
}
},
"/public/events/{eventId}/products": {
"get": {
"operationId": "events.getEventPublicAction.getPublicEventsEventIdProducts",
"summary": "Get Event (public)",
"tags": [
"Events"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`EventResourcePublic`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EventResourcePublic"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"description": ""
}
},
"security": []
}
},
"/events/{eventId}/images": {
"post": {
"operationId": "images.createEventImageAction",
"summary": "Create Event Image",
"tags": [
"Events / Images"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/CreateEventImageRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"get": {
"operationId": "images.getEventImagesAction",
"summary": "Get Event Images",
"tags": [
"Events / Images"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Array of `ImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/images/{imageId}": {
"delete": {
"operationId": "images.deleteEventImageAction",
"summary": "Delete Event Image",
"tags": [
"Events / Images"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "imageId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/stats": {
"get": {
"operationId": "stats.getEventStatsAction",
"summary": "Get Event Stats",
"tags": [
"Events / Stats"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "occurrence_id",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "date_range",
"in": "query",
"schema": {
"type": "string",
"default": "month"
}
}
],
"responses": {
"200": {
"description": "`JsonResource`",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/JsonResource"
}
},
"required": [
"data"
]
},
{
"type": "object",
"properties": {
"data": {
"type": "string"
}
},
"required": [
"data"
]
}
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/counts": {
"get": {
"operationId": "stats.getEventCountsAction",
"summary": "Get Event Counts",
"tags": [
"Events / Stats"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`JsonResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/JsonResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/images": {
"post": {
"operationId": "images.createImageAction",
"summary": "Create Image",
"tags": [
"Images"
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/CreateImageRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ImageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ImageResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/images/{imageId}": {
"delete": {
"operationId": "images.deleteImageAction",
"summary": "Delete Image",
"tags": [
"Images"
],
"parameters": [
{
"name": "imageId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/public/lifecycle-emails/unsubscribe/{token}": {
"post": {
"operationId": "lifecycleEmails.unsubscribeFromLifecycleEmailsAction",
"summary": "Unsubscribe From Lifecycle Emails (public)",
"tags": [
"Lifecycle Emails"
],
"parameters": [
{
"name": "token",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"404": {
"description": ""
},
"429": {
"description": "Too many requests. Retry once the rate limit window resets.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
},
"security": []
}
},
"/organizers/{organizerId}/profiles": {
"get": {
"operationId": "lineup.getProfilesAction",
"summary": "Get Profiles",
"tags": [
"Lineup"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Array of `ProfileResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProfileResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"post": {
"operationId": "lineup.createProfileAction",
"summary": "Create Profile",
"tags": [
"Lineup"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertProfileRequest"
}
}
}
},
"responses": {
"201": {
"description": "`ProfileResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProfileResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/organizers/{organizerId}/profiles/{profileId}": {
"put": {
"operationId": "lineup.updateProfileAction",
"summary": "Update Profile",
"tags": [
"Lineup"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "profileId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertProfileRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ProfileResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProfileResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"delete": {
"operationId": "lineup.deleteProfileAction",
"summary": "Delete Profile",
"tags": [
"Lineup"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "profileId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/organizers/{organizerId}/profiles/{profileId}/images/sort": {
"post": {
"operationId": "lineup.sortProfileImagesAction",
"summary": "Sort Profile Images",
"tags": [
"Lineup"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "profileId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SortProfileImagesRequest"
}
}
}
},
"responses": {
"204": {
"description": "No content"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/lineup": {
"get": {
"operationId": "lineup.getEventLineupAction",
"summary": "Get Event Lineup",
"tags": [
"Lineup"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`EventLineupResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EventLineupResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/lineup/export": {
"get": {
"operationId": "lineup.exportEventLineupAction",
"summary": "Export Event Lineup",
"tags": [
"Lineup"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "File download",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/lineup/import": {
"post": {
"operationId": "lineup.importLineupAction",
"summary": "Import Lineup",
"tags": [
"Lineup"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportLineupRequest"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {}
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/lineup/entries": {
"post": {
"operationId": "lineup.createLineupEntryAction",
"summary": "Create Lineup Entry",
"tags": [
"Lineup"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateLineupEntryRequest"
}
}
}
},
"responses": {
"201": {
"description": "`LineupEntryResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/LineupEntryResource"
}
},
"required": [
"data"
]
}
}
}
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/lineup/entries/sort": {
"post": {
"operationId": "lineup.sortLineupEntriesAction",
"summary": "Sort Lineup Entries",
"tags": [
"Lineup"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SortLineupEntriesRequest"
}
}
}
},
"responses": {
"204": {
"description": "No content"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/lineup/entries/{lineupEntryId}": {
"put": {
"operationId": "lineup.updateLineupEntryAction",
"summary": "Update Lineup Entry",
"tags": [
"Lineup"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "lineupEntryId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateLineupEntryRequest"
}
}
}
},
"responses": {
"200": {
"description": "`LineupEntryResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/LineupEntryResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"delete": {
"operationId": "lineup.deleteLineupEntryAction",
"summary": "Delete Lineup Entry",
"tags": [
"Lineup"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "lineupEntryId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/lineup/spaces": {
"post": {
"operationId": "lineup.createEventSpaceAction",
"summary": "Create Event Space",
"tags": [
"Lineup"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertEventSpaceRequest"
}
}
}
},
"responses": {
"201": {
"description": "`EventSpaceResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EventSpaceResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/lineup/spaces/{spaceId}": {
"put": {
"operationId": "lineup.updateEventSpaceAction",
"summary": "Update Event Space",
"tags": [
"Lineup"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "spaceId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertEventSpaceRequest"
}
}
}
},
"responses": {
"200": {
"description": "`EventSpaceResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EventSpaceResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"delete": {
"operationId": "lineup.deleteEventSpaceAction",
"summary": "Delete Event Space",
"tags": [
"Lineup"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "spaceId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/lineup/schedule-items": {
"post": {
"operationId": "lineup.createScheduleItemAction",
"summary": "Create Schedule Item",
"tags": [
"Lineup"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertScheduleItemRequest"
}
}
}
},
"responses": {
"201": {
"description": "`ScheduleItemResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ScheduleItemResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/lineup/schedule-items/{scheduleItemId}": {
"put": {
"operationId": "lineup.updateScheduleItemAction",
"summary": "Update Schedule Item",
"tags": [
"Lineup"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "scheduleItemId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertScheduleItemRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ScheduleItemResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ScheduleItemResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"delete": {
"operationId": "lineup.deleteScheduleItemAction",
"summary": "Delete Schedule Item",
"tags": [
"Lineup"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "scheduleItemId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/public/events/{eventId}/lineup": {
"get": {
"operationId": "lineup.getEventLineupPublicAction",
"summary": "Get Event Lineup (public)",
"tags": [
"Lineup"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`EventLineupResourcePublic`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EventLineupResourcePublic"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"description": ""
}
},
"security": []
}
},
"/organizers/{organizerId}/locations": {
"get": {
"operationId": "locations.getLocationsAction",
"summary": "Get Locations",
"tags": [
"Locations"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Paginated set of `LocationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LocationResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"post": {
"operationId": "locations.createLocationAction",
"summary": "Create Location",
"tags": [
"Locations"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertLocationRequest"
}
}
}
},
"responses": {
"201": {
"description": "`LocationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/LocationResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/geo/status": {
"get": {
"operationId": "locations.getGeoStatusAction",
"summary": "Get Geo Status",
"tags": [
"Locations"
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"available": {
"type": "boolean"
}
},
"required": [
"available"
]
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/organizers/{organizerId}/locations/autocomplete": {
"get": {
"operationId": "locations.geoAutocompleteAction",
"summary": "Geo Autocomplete",
"tags": [
"Locations"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "query",
"in": "query",
"required": true,
"description": "Address search term.",
"schema": {
"type": "string"
}
},
{
"name": "locale",
"in": "query",
"description": "Locale for the returned suggestions.",
"schema": {
"type": "string"
}
},
{
"name": "country",
"in": "query",
"description": "Two-letter country code used to bias the results.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Array of `GeoSuggestionResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GeoSuggestionResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"502": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"429": {
"description": "Too many requests. Retry once the rate limit window resets.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/organizers/{organizerId}/locations/places/{placeId}": {
"get": {
"operationId": "locations.geoPlaceDetailsAction",
"summary": "Geo Place Details",
"tags": [
"Locations"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "placeId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "locale",
"in": "query",
"description": "Locale for the returned place details.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "`GeoPlaceResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/GeoPlaceResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"502": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"429": {
"description": "Too many requests. Retry once the rate limit window resets.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/organizers/{organizerId}/locations/{locationId}": {
"put": {
"operationId": "locations.updateLocationAction",
"summary": "Update Location",
"tags": [
"Locations"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "locationId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertLocationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`LocationResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/LocationResource"
}
},
"required": [
"data"
]
}
}
}
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"delete": {
"operationId": "locations.deleteLocationAction",
"summary": "Delete Location",
"tags": [
"Locations"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "locationId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/messages": {
"post": {
"operationId": "messages.sendMessageAction",
"summary": "Send Message",
"tags": [
"Messages"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SendMessageRequest"
}
}
}
},
"responses": {
"200": {
"description": "`MessageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/MessageResource"
}
},
"required": [
"data"
]
}
}
}
},
"429": {
"description": "Too many requests. Retry once the rate limit window resets.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"get": {
"operationId": "messages.getMessagesAction",
"summary": "Get Messages",
"tags": [
"Messages"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Paginated set of `MessageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MessageResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/messages/{messageId}/cancel": {
"post": {
"operationId": "messages.cancelMessageAction",
"summary": "Cancel Message",
"tags": [
"Messages"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "messageId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`MessageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/MessageResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/messages/{messageId}/recipients": {
"get": {
"operationId": "messages.getMessageRecipientsAction",
"summary": "Get Message Recipients",
"tags": [
"Messages"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "messageId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"default": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"default": 25
}
},
{
"name": "sort_by",
"in": "query",
"description": "Sortable fields are listed in the response `meta.allowed_sorts`.",
"schema": {
"type": "string"
}
},
{
"name": "sort_direction",
"in": "query",
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"name": "query",
"in": "query",
"description": "Search term used to filter the results.",
"schema": {
"type": "string"
}
},
{
"name": "filter_fields",
"in": "query",
"description": "Filters in the form `filter_fields[field][operator]=value`. Filterable fields are listed in the response `meta.allowed_filter_fields`.",
"style": "deepObject",
"schema": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"explode": true
}
],
"responses": {
"200": {
"description": "Paginated set of `OutgoingMessageResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OutgoingMessageResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/orders": {
"get": {
"operationId": "orders.getOrdersAction",
"summary": "Get Orders",
"tags": [
"Orders"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"default": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"default": 25
}
},
{
"name": "sort_by",
"in": "query",
"description": "Sortable fields are listed in the response `meta.allowed_sorts`.",
"schema": {
"type": "string"
}
},
{
"name": "sort_direction",
"in": "query",
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"name": "query",
"in": "query",
"description": "Search term used to filter the results.",
"schema": {
"type": "string"
}
},
{
"name": "filter_fields",
"in": "query",
"description": "Filters in the form `filter_fields[field][operator]=value`. Filterable fields are listed in the response `meta.allowed_filter_fields`.",
"style": "deepObject",
"schema": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"explode": true
}
],
"responses": {
"200": {
"description": "Array of `OrderResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/orders/{orderId}": {
"get": {
"operationId": "orders.getOrderAction",
"summary": "Get Order",
"tags": [
"Orders"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "orderId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`OrderResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/OrderResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"put": {
"operationId": "orders.editOrderAction",
"summary": "Edit Order",
"tags": [
"Orders"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "orderId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EditOrderRequest"
}
}
}
},
"responses": {
"200": {
"description": "`OrderResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/OrderResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/orders/{orderId}/resend_confirmation": {
"post": {
"operationId": "orders.resendOrderConfirmationAction",
"summary": "Resend Order Confirmation",
"tags": [
"Orders"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "orderId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"422": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"404": {
"description": ""
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/orders/{orderId}/cancel": {
"post": {
"operationId": "orders.cancelOrderAction",
"summary": "Cancel Order",
"tags": [
"Orders"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "orderId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"refund": {
"type": "boolean",
"default": false
}
}
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/orders/{orderId}/mark-as-paid": {
"post": {
"operationId": "orders.markOrderAsPaidAction",
"summary": "Mark Order As Paid",
"tags": [
"Orders"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "orderId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`OrderResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/OrderResource"
}
},
"required": [
"data"
]
}
}
}
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/orders/export": {
"post": {
"operationId": "orders.exportOrdersAction",
"summary": "Export Orders",
"tags": [
"Orders"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"product_ids": {
"type": [
"array",
"null"
],
"items": {
"type": "integer"
},
"maxItems": 500
}
}
}
}
}
},
"responses": {
"200": {
"description": "File download",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/orders/{orderId}/invoice": {
"get": {
"operationId": "orders.downloadOrderInvoiceAction",
"summary": "Download Order Invoice",
"tags": [
"Orders"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "orderId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Invoice PDF",
"content": {
"application/json": {
"schema": {
"type": "object"
}
},
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/orders/{orderId}/refund": {
"post": {
"operationId": "payment.refundOrderAction",
"summary": "Refund Order",
"tags": [
"Orders / Payment"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "orderId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RefundOrderRequest"
}
}
}
},
"responses": {
"200": {
"description": "`OrderResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/OrderResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/public/events/{eventId}/order/{orderShortId}/stripe/payment_intent": {
"post": {
"operationId": "stripe.createPaymentIntentActionPublic",
"summary": "Create Payment Intent (public)",
"tags": [
"Orders / Payment / Stripe"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "orderShortId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"client_secret": {
"type": "string"
},
"account_id": {
"anyOf": [
{
"type": "null"
},
{
"type": "string"
}
]
},
"public_key": {
"type": [
"string",
"null"
]
},
"stripe_platform": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"client_secret",
"account_id",
"public_key",
"stripe_platform"
]
}
}
}
},
"422": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"429": {
"description": "Too many requests. Retry once the rate limit window resets.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
},
"security": []
},
"get": {
"operationId": "stripe.getPaymentIntentActionPublic",
"summary": "Get Payment Intent (public)",
"tags": [
"Orders / Payment / Stripe"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "orderShortId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"paymentIntentId": {
"type": "string"
},
"amount": {
"type": "string"
}
},
"required": [
"status",
"paymentIntentId",
"amount"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
},
"security": []
}
},
"/public/events/{eventId}/order": {
"post": {
"operationId": "public.createOrderActionPublic",
"description": "`products.*.event_occurrence_id` is required for recurring events; for single-occurrence\nevents it is inferred when omitted. Product availability, capacity, and pricing are\nvalidated against the event's live configuration.",
"summary": "Create Order (public)",
"tags": [
"Orders / Public"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateOrderRequest"
}
}
}
},
"responses": {
"201": {
"description": "`OrderResourcePublic`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/OrderResourcePublic"
}
},
"required": [
"data"
]
}
}
}
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "object",
"properties": {
"unavailable_seat_uids": {
"type": "string"
}
},
"required": [
"unavailable_seat_uids"
]
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"403": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"429": {
"description": "Too many requests. Retry once the rate limit window resets.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
},
"security": []
}
},
"/public/events/{eventId}/order/{orderShortId}": {
"put": {
"operationId": "public.completeOrderActionPublic",
"description": "`order.questions` and `products.*.questions` are validated against the questions configured\nfor the event. The `order.address` fields become required when the event's settings require\na billing address.",
"summary": "Complete Order (public)",
"tags": [
"Orders / Public"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "orderShortId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CompleteOrderRequest"
},
{
"type": "object",
"properties": {
"order": {
"type": "object",
"properties": {
"opted_into_marketing": {
"type": "boolean",
"default": false
}
}
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "`OrderResourcePublic`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/OrderResourcePublic"
}
},
"required": [
"data"
]
}
}
}
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
},
"security": []
},
"get": {
"operationId": "public.getOrderActionPublic",
"summary": "Get Order (public)",
"tags": [
"Orders / Public"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "orderShortId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "session_identifier",
"in": "query",
"description": "Checkout session identifier issued when the order was created, or a payment-link token. A checkout session identifier also sets the checkout session cookie on the response.",
"schema": {
"type": "string"
}
},
{
"name": "include",
"in": "query",
"description": "Comma-separated list of relations to include in the response.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "`OrderResourcePublic`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/OrderResourcePublic"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
},
"security": []
},
"patch": {
"operationId": "selfService.editOrderPublicAction",
"summary": "Edit Order (public)",
"tags": [
"Self Service"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "orderShortId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EditOrderPublicRequest"
}
}
}
},
"responses": {
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"const": "Order updated successfully"
},
"new_short_id": {
"type": "string"
}
},
"required": [
"message",
"new_short_id"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"429": {
"description": "Too many requests. Retry once the rate limit window resets.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
},
"security": []
}
},
"/public/events/{eventId}/order/{orderShortId}/abandon": {
"post": {
"operationId": "public.abandonOrderActionPublic",
"summary": "Abandon Order (public)",
"tags": [
"Orders / Public"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "orderShortId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"401": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"200": {
"description": "`OrderResourcePublic`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/OrderResourcePublic"
}
},
"required": [
"data"
]
}
}
}
}
},
"security": []
}
},
"/public/events/{eventId}/order/{orderShortId}/await-offline-payment": {
"post": {
"operationId": "public.transitionOrderToOfflinePaymentPublicAction",
"summary": "Transition Order To Offline Payment (public)",
"tags": [
"Orders / Public"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "orderShortId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "`OrderResourcePublic`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/OrderResourcePublic"
}
},
"required": [
"data"
]
}
}
}
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
},
"security": []
}
},
"/public/events/{eventId}/order/{orderShortId}/payment-link": {
"post": {
"operationId": "public.createOrderPaymentLinkActionPublic",
"summary": "Create Order Payment Link (public)",
"tags": [
"Orders / Public"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "orderShortId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "`OrderResourcePublic`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/OrderResourcePublic"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"403": {
"description": "Access denied",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}
}
}
},
"429": {
"description": "Too many requests. Retry once the rate limit window resets.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
},
"security": []
}
},
"/public/events/{eventId}/order/{orderShortId}/report-offline-payment": {
"post": {
"operationId": "public.reportOfflinePaymentActionPublic",
"summary": "Report Offline Payment (public)",
"tags": [
"Orders / Public"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "orderShortId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReportOfflinePaymentRequest"
}
}
}
},
"responses": {
"200": {
"description": "`OrderResourcePublic`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/OrderResourcePublic"
}
},
"required": [
"data"
]
}
}
}
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"429": {
"description": "Too many requests. Retry once the rate limit window resets.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
},
"security": []
}
},
"/public/events/{eventId}/order/{orderShortId}/invoice": {
"get": {
"operationId": "public.downloadOrderInvoicePublicAction",
"summary": "Download Order Invoice (public)",
"tags": [
"Orders / Public"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "orderShortId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Invoice PDF",
"content": {
"application/json": {
"schema": {
"type": "object"
}
},
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
},
"security": []
}
},
"/organizers": {
"post": {
"operationId": "organizers.createOrganizerAction",
"summary": "Create Organizer",
"tags": [
"Organizers"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertOrganizerRequest"
}
}
}
},
"responses": {
"201": {
"description": "`OrganizerResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/OrganizerResource"
}
},
"required": [
"data"
]
}
}
}
},
"403": {
"description": "Access denied",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
}
}
},
"get": {
"operationId": "organizers.getOrganizersAction",
"summary": "Get Organizers",
"tags": [
"Organizers"
],
"responses": {
"200": {
"description": "Array of `OrganizerResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrganizerResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/organizers/{organizerId}": {
"post": {
"operationId": "organizers.editOrganizerAction",
"summary": "Edit Organizer",
"tags": [
"Organizers"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertOrganizerRequest"
}
}
}
},
"responses": {
"200": {
"description": "`OrganizerResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/OrganizerResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"delete": {
"operationId": "organizers.deleteOrganizerAction",
"summary": "Delete Organizer",
"tags": [
"Organizers"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"get": {
"operationId": "organizers.getOrganizerAction",
"summary": "Get Organizer",
"tags": [
"Organizers"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`OrganizerResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/OrganizerResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"description": ""
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/organizers/{organizerId}/status": {
"put": {
"operationId": "organizers.updateOrganizerStatusAction",
"summary": "Update Organizer Status",
"tags": [
"Organizers"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateOrganizerStatusRequest"
}
}
}
},
"responses": {
"200": {
"description": "`OrganizerResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/OrganizerResource"
}
},
"required": [
"data"
]
}
}
}
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/organizers/{organizerId}/deletion-status": {
"get": {
"operationId": "organizers.getOrganizerDeletionStatusAction",
"summary": "Get Organizer Deletion Status",
"tags": [
"Organizers"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"can_delete": {
"type": "boolean"
},
"reason": {
"type": [
"string",
"null"
],
"enum": [
"This organizer has events with completed orders. Please cancel or refund all orders first.",
"You cannot delete the last organizer on your account.",
null
]
}
},
"required": [
"can_delete",
"reason"
]
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/organizers/{organizerId}/events": {
"get": {
"operationId": "organizers.getOrganizerEventsAction",
"summary": "Get Organizer Events",
"tags": [
"Organizers"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Paginated set of `EventResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/organizers/{organizerId}/location": {
"patch": {
"operationId": "organizers.updateOrganizerLocationAction",
"summary": "Update Organizer Location",
"tags": [
"Organizers"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateOrganizerLocationRequest"
}
}
}
},
"responses": {
"200": {
"description": "`OrganizerResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/OrganizerResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/public/organizers/{organizerId}": {
"get": {
"operationId": "organizers.getPublicOrganizerAction",
"summary": "Get Organizer (public)",
"tags": [
"Organizers"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`OrganizerResourcePublic`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/OrganizerResourcePublic"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"description": ""
}
},
"security": []
}
},
"/organizers/{organizerId}/orders": {
"get": {
"operationId": "orders.getOrganizerOrdersAction",
"summary": "Get Organizer Orders",
"tags": [
"Organizers / Orders"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"default": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"default": 25
}
},
{
"name": "sort_by",
"in": "query",
"description": "Sortable fields are listed in the response `meta.allowed_sorts`.",
"schema": {
"type": "string"
}
},
{
"name": "sort_direction",
"in": "query",
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"name": "query",
"in": "query",
"description": "Search term used to filter the results.",
"schema": {
"type": "string"
}
},
{
"name": "filter_fields",
"in": "query",
"description": "Filters in the form `filter_fields[field][operator]=value`. Filterable fields are listed in the response `meta.allowed_filter_fields`.",
"style": "deepObject",
"schema": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"explode": true
}
],
"responses": {
"200": {
"description": "Array of `OrderResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/public/organizers/{organizerId}/contact": {
"post": {
"operationId": "public.sendOrganizerContactMessagePublicAction",
"summary": "Send Organizer Contact Message (public)",
"tags": [
"Organizers / Public"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 255
},
"email": {
"type": "string",
"format": "email",
"maxLength": 255
},
"message": {
"type": "string",
"maxLength": 5000
}
},
"required": [
"name",
"email",
"message"
]
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"const": "Message sent successfully"
}
},
"required": [
"message"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"429": {
"description": "Too many requests. Retry once the rate limit window resets.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
},
"security": []
}
},
"/organizers/{organizerId}/settings": {
"get": {
"operationId": "settings.getOrganizerSettingsAction",
"summary": "Get Organizer Settings",
"tags": [
"Organizers / Settings"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`OrganizerSettingsResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/OrganizerSettingsResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"description": ""
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"patch": {
"operationId": "settings.partialUpdateOrganizerSettingsAction",
"summary": "Partial Update Organizer Settings",
"tags": [
"Organizers / Settings"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PartialUpdateOrganizerSettingsRequest"
}
}
}
},
"responses": {
"200": {
"description": "`OrganizerSettingsResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/OrganizerSettingsResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/organizers/{organizerId}/stats": {
"get": {
"operationId": "stats.getOrganizerStatsAction",
"summary": "Get Organizer Stats",
"tags": [
"Organizers / Stats"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "date_range",
"in": "query",
"schema": {
"type": "string",
"default": "month"
}
},
{
"name": "currency_code",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/OrganizerStatsResponseDTO"
}
]
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/organizers/{organizerId}/vat-settings": {
"get": {
"operationId": "vat.getOrganizerVatSettingAction",
"summary": "Get Organizer Vat Setting",
"tags": [
"Organizers / Vat"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`OrganizerVatSettingResource`",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/OrganizerVatSettingResource"
}
},
"required": [
"data"
]
},
{
"type": "object",
"properties": {
"data": {
"type": "null"
}
},
"required": [
"data"
]
}
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/organizers/{organizerId}/webhooks": {
"post": {
"operationId": "webhooks.createOrganizerWebhookAction",
"summary": "Create Organizer Webhook",
"tags": [
"Organizers / Webhooks"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertWebhookRequest"
}
}
}
},
"responses": {
"200": {
"description": "`WebhookResourceWithSecret`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/WebhookResourceWithSecret"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"get": {
"operationId": "webhooks.getOrganizerWebhooksAction",
"summary": "Get Organizer Webhooks",
"tags": [
"Organizers / Webhooks"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Array of `WebhookResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/organizers/{organizerId}/webhooks/{webhookId}": {
"put": {
"operationId": "webhooks.editOrganizerWebhookAction",
"summary": "Edit Organizer Webhook",
"tags": [
"Organizers / Webhooks"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "webhookId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertWebhookRequest"
}
}
}
},
"responses": {
"200": {
"description": "`WebhookResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/WebhookResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"get": {
"operationId": "webhooks.getOrganizerWebhookAction",
"summary": "Get Organizer Webhook",
"tags": [
"Organizers / Webhooks"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "webhookId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`WebhookResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/WebhookResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"delete": {
"operationId": "webhooks.deleteOrganizerWebhookAction",
"summary": "Delete Organizer Webhook",
"tags": [
"Organizers / Webhooks"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "webhookId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/organizers/{organizerId}/webhooks/{webhookId}/logs": {
"get": {
"operationId": "webhooks.getOrganizerWebhookLogsAction",
"summary": "Get Organizer Webhook Logs",
"tags": [
"Organizers / Webhooks"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "webhookId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Array of `WebhookLogResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookLogResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/product-categories": {
"post": {
"operationId": "productCategories.createProductCategoryAction",
"summary": "Create Product Category",
"tags": [
"Product Categories"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertProductCategoryRequest"
}
}
}
},
"responses": {
"201": {
"description": "`ProductCategoryResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProductCategoryResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"get": {
"operationId": "productCategories.getProductCategoriesAction",
"summary": "Get Product Categories",
"tags": [
"Product Categories"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Array of `ProductCategoryResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductCategoryResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/product-categories/{productCategoryId}": {
"get": {
"operationId": "productCategories.getProductCategoryAction",
"summary": "Get Product Category",
"tags": [
"Product Categories"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "productCategoryId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`ProductCategoryResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProductCategoryResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"put": {
"operationId": "productCategories.editProductCategoryAction",
"summary": "Edit Product Category",
"tags": [
"Product Categories"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "productCategoryId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertProductCategoryRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ProductCategoryResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProductCategoryResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"delete": {
"operationId": "productCategories.deleteProductCategoryAction",
"summary": "Delete Product Category",
"tags": [
"Product Categories"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "productCategoryId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/products": {
"post": {
"operationId": "products.createProductAction",
"summary": "Create Product",
"tags": [
"Products"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertProductRequest"
}
}
}
},
"responses": {
"201": {
"description": "`ProductResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProductResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"get": {
"operationId": "products.getProductsAction",
"summary": "Get Products",
"tags": [
"Products"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"default": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"default": 25
}
},
{
"name": "sort_by",
"in": "query",
"description": "Sortable fields are listed in the response `meta.allowed_sorts`.",
"schema": {
"type": "string"
}
},
{
"name": "sort_direction",
"in": "query",
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"name": "query",
"in": "query",
"description": "Search term used to filter the results.",
"schema": {
"type": "string"
}
},
{
"name": "filter_fields",
"in": "query",
"description": "Filters in the form `filter_fields[field][operator]=value`. Filterable fields are listed in the response `meta.allowed_filter_fields`.",
"style": "deepObject",
"schema": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"explode": true
}
],
"responses": {
"200": {
"description": "Paginated set of `ProductResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/products/sort": {
"post": {
"operationId": "products.sortProductsAction",
"summary": "Sort Products",
"tags": [
"Products"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SortProductsRequest"
}
}
}
},
"responses": {
"204": {
"description": "No content"
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/products/{productId}": {
"put": {
"operationId": "products.editProductAction",
"summary": "Edit Product",
"tags": [
"Products"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "productId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertProductRequest"
}
}
}
},
"responses": {
"200": {
"description": "`ProductResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProductResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"get": {
"operationId": "products.getProductAction",
"summary": "Get Product",
"tags": [
"Products"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "productId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`ProductResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProductResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"description": ""
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"delete": {
"operationId": "products.deleteProductAction",
"summary": "Delete Product",
"tags": [
"Products"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "productId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/products/purchases/export": {
"post": {
"operationId": "purchases.exportProductPurchasesAction",
"summary": "Export Product Purchases",
"tags": [
"Products / Purchases"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportProductPurchasesRequest"
}
}
}
},
"responses": {
"200": {
"description": "File download",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"404": {
"description": ""
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/products/{productId}/purchases": {
"get": {
"operationId": "purchases.getProductPurchasesAction",
"summary": "Get Product Purchases",
"tags": [
"Products / Purchases"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "productId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"default": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"default": 25
}
},
{
"name": "sort_by",
"in": "query",
"description": "Sortable fields are listed in the response `meta.allowed_sorts`.",
"schema": {
"type": "string"
}
},
{
"name": "sort_direction",
"in": "query",
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"name": "query",
"in": "query",
"description": "Search term used to filter the results.",
"schema": {
"type": "string"
}
},
{
"name": "filter_fields",
"in": "query",
"description": "Filters in the form `filter_fields[field][operator]=value`. Filterable fields are listed in the response `meta.allowed_filter_fields`.",
"style": "deepObject",
"schema": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"explode": true
}
],
"responses": {
"200": {
"description": "Array of `ProductPurchaseResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductPurchaseResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"description": ""
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/products/{productId}/purchases/summary": {
"get": {
"operationId": "purchases.getProductPurchaseSummaryAction",
"summary": "Get Product Purchase Summary",
"tags": [
"Products / Purchases"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "productId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "event_occurrence_id",
"in": "query",
"schema": {
"type": [
"integer",
"null"
]
}
}
],
"responses": {
"200": {
"description": "`ProductPurchaseSummaryResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ProductPurchaseSummaryResource"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"description": ""
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/promo-codes": {
"post": {
"operationId": "promoCodes.createPromoCodeAction",
"summary": "Create Promo Code",
"tags": [
"Promo Codes"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateUpdatePromoCodeRequest"
}
}
}
},
"responses": {
"201": {
"description": "`PromoCodeResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PromoCodeResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"get": {
"operationId": "promoCodes.getPromoCodesAction",
"summary": "Get Promo Codes",
"tags": [
"Promo Codes"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Array of `PromoCodeResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PromoCodeResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/promo-codes/{promoCodeId}": {
"put": {
"operationId": "promoCodes.updatePromoCodeAction",
"summary": "Update Promo Code",
"tags": [
"Promo Codes"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "promoCodeId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateUpdatePromoCodeRequest"
}
}
}
},
"responses": {
"201": {
"description": "`PromoCodeResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PromoCodeResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"get": {
"operationId": "promoCodes.getPromoCodeAction",
"summary": "Get Promo Code",
"tags": [
"Promo Codes"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "promoCodeId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`PromoCodeResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/PromoCodeResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"delete": {
"operationId": "promoCodes.deletePromoCodeAction",
"summary": "Delete Promo Code",
"tags": [
"Promo Codes"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "promoCodeId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/public/events/{eventId}/promo-codes/{promoCode}": {
"get": {
"operationId": "promoCodes.getPromoCodePublic",
"summary": "Get Promo Code (public)",
"tags": [
"Promo Codes"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "promoCode",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"valid": {
"type": "boolean"
},
"discount": {
"type": "string"
},
"discount_type": {
"type": "string"
},
"discount_applies_to": {
"type": "string"
},
"applies_to_all_products": {
"type": "string"
}
},
"required": [
"valid",
"discount",
"discount_type",
"discount_applies_to",
"applies_to_all_products"
]
},
{
"type": "object",
"properties": {
"valid": {
"type": "boolean"
}
},
"required": [
"valid"
]
}
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"429": {
"description": "Too many requests. Retry once the rate limit window resets.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
},
"security": []
}
},
"/events/{eventId}/questions": {
"post": {
"operationId": "questions.createQuestionAction",
"summary": "Create Question",
"tags": [
"Questions"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertQuestionRequest"
}
}
}
},
"responses": {
"201": {
"description": "`QuestionResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/QuestionResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"get": {
"operationId": "questions.getQuestionsAction",
"summary": "Get Questions",
"tags": [
"Questions"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Array of `QuestionResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuestionResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/questions/{questionId}": {
"put": {
"operationId": "questions.editQuestionAction",
"summary": "Edit Question",
"tags": [
"Questions"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "questionId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertQuestionRequest"
}
}
}
},
"responses": {
"200": {
"description": "`QuestionResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/QuestionResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"get": {
"operationId": "questions.getQuestionAction",
"summary": "Get Question",
"tags": [
"Questions"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "questionId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`QuestionResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/QuestionResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"delete": {
"operationId": "questions.deleteQuestionAction",
"summary": "Delete Question",
"tags": [
"Questions"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "questionId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/questions/sort": {
"post": {
"operationId": "questions.sortQuestionsAction",
"summary": "Sort Questions",
"tags": [
"Questions"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SortQuestionsRequest"
}
}
}
},
"responses": {
"204": {
"description": "No content"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/questions/{questionId}/answers/{questionAnswerId}": {
"put": {
"operationId": "questions.editQuestionAnswerAction",
"summary": "Edit Question Answer",
"tags": [
"Questions"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "questionId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "questionAnswerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EditQuestionAnswerRequest"
}
}
}
},
"responses": {
"204": {
"description": "No content"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/questions/answers/export": {
"get": {
"operationId": "questions.exportQuestionAnswersAction",
"summary": "Export Question Answers",
"tags": [
"Questions"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"message": {
"type": "string",
"const": "Job started successfully"
},
"status": {
"type": "string"
},
"job_uuid": {
"type": "string"
}
},
"required": [
"message",
"status",
"job_uuid"
]
},
{
"type": "object",
"properties": {
"message": {
"type": "string",
"enum": [
"Job is still in progress",
"Job completed successfully",
"Export file not found",
"Job failed",
"Job not found"
]
},
"status": {
"type": "string"
},
"job_uuid": {
"type": "string"
},
"download_url": {
"type": "null"
}
},
"required": [
"message",
"status",
"job_uuid",
"download_url"
]
}
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/public/events/{eventId}/questions": {
"get": {
"operationId": "questions.getQuestionsPublicAction",
"summary": "Get Questions (public)",
"tags": [
"Questions"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Array of `QuestionResourcePublic`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QuestionResourcePublic"
}
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
},
"security": []
}
},
"/organizers/{organizerId}/reports/{reportType}": {
"get": {
"operationId": "reports.getOrganizerReportAction",
"description": "The response rows depend on the requested `reportType`. Paginated report types return\n`{data, meta, links}`; non-paginated report types return `{data}`.",
"summary": "Get Organizer Report",
"tags": [
"Reports"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "reportType",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "start_date",
"in": "query",
"schema": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
{
"name": "end_date",
"in": "query",
"schema": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
{
"name": "currency",
"in": "query",
"schema": {
"type": [
"string",
"null"
],
"minLength": 3,
"maxLength": 3
}
},
{
"name": "event_id",
"in": "query",
"schema": {
"type": [
"integer",
"null"
]
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": [
"integer",
"null"
],
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": [
"integer",
"null"
],
"minimum": 1,
"maximum": 1000
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"data": {
"anyOf": [
{
"$ref": "#/components/schemas/PaginatedReportDTO"
},
{
"type": "array",
"items": {}
}
]
}
},
"required": [
"data"
]
},
{
"anyOf": [
{
"type": "object",
"properties": {
"data": {
"type": "object",
"additionalProperties": {}
},
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "integer"
},
"page": {
"type": "integer",
"const": 1
},
"per_page": {
"type": "integer",
"const": 1000
},
"last_page": {
"type": "integer"
}
},
"required": [
"total",
"page",
"per_page",
"last_page"
]
}
},
"required": [
"data",
"pagination"
]
},
{
"type": "object",
"properties": {
"data": {
"type": "object",
"additionalProperties": {}
},
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "integer"
},
"page": {
"type": "integer"
},
"per_page": {
"type": "integer"
},
"last_page": {
"type": "integer"
}
},
"required": [
"total",
"page",
"per_page",
"last_page"
]
}
},
"required": [
"data",
"pagination"
]
},
{
"type": "array",
"items": {}
}
]
}
]
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/organizers/{organizerId}/reports/{reportType}/export": {
"get": {
"operationId": "reports.exportOrganizerReportAction",
"summary": "Export Organizer Report",
"tags": [
"Reports"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "reportType",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "start_date",
"in": "query",
"schema": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
{
"name": "end_date",
"in": "query",
"schema": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
{
"name": "currency",
"in": "query",
"schema": {
"type": [
"string",
"null"
],
"minLength": 3,
"maxLength": 3
}
},
{
"name": "event_id",
"in": "query",
"schema": {
"type": [
"integer",
"null"
]
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": [
"integer",
"null"
],
"minimum": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": [
"integer",
"null"
],
"minimum": 1,
"maximum": 1000
}
}
],
"responses": {
"200": {
"description": "File download",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/reports/{reportType}": {
"get": {
"operationId": "reports.getReportAction",
"summary": "Get Report",
"tags": [
"Reports"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "reportType",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "start_date",
"in": "query",
"schema": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
{
"name": "end_date",
"in": "query",
"schema": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
{
"name": "occurrence_id",
"in": "query",
"schema": {
"type": [
"integer",
"null"
]
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {}
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/organizers/{organizerId}/seat-maps": {
"get": {
"operationId": "actions.getSeatMapsAction",
"summary": "Get Seat Maps",
"tags": [
"Seating"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Paginated set of `SeatMapPreviewResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SeatMapPreviewResource"
}
},
"links": {
"type": "object",
"properties": {
"first": {
"type": [
"string",
"null"
]
},
"last": {
"type": [
"string",
"null"
]
},
"prev": {
"type": [
"string",
"null"
]
},
"next": {
"type": [
"string",
"null"
]
}
},
"required": [
"first",
"last",
"prev",
"next"
]
},
"meta": {
"type": "object",
"properties": {
"current_page": {
"type": "integer",
"minimum": 1
},
"from": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"last_page": {
"type": "integer",
"minimum": 1
},
"links": {
"type": "array",
"description": "Generated paginator links.",
"items": {
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
},
"active": {
"type": "boolean"
}
},
"required": [
"url",
"label",
"active"
]
}
},
"path": {
"type": [
"string",
"null"
],
"description": "Base path for paginator generated URLs."
},
"per_page": {
"type": "integer",
"description": "Number of items shown per page.",
"minimum": 0
},
"to": {
"type": [
"integer",
"null"
],
"description": "Number of the last item in the slice.",
"minimum": 1
},
"total": {
"type": "integer",
"description": "Total number of items being paginated.",
"minimum": 0
}
},
"required": [
"current_page",
"from",
"last_page",
"links",
"path",
"per_page",
"to",
"total"
]
}
},
"required": [
"data",
"links",
"meta"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"post": {
"operationId": "actions.createSeatMapAction",
"summary": "Create Seat Map",
"tags": [
"Seating"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertSeatMapRequest"
}
}
}
},
"responses": {
"201": {
"description": "`SeatMapResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SeatMapResource"
}
},
"required": [
"data"
]
}
}
}
},
"403": {
"description": "Access denied",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/organizers/{organizerId}/seat-maps/{seatMapId}": {
"get": {
"operationId": "actions.getSeatMapAction",
"summary": "Get Seat Map",
"tags": [
"Seating"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "seatMapId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`SeatMapResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SeatMapResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"put": {
"operationId": "actions.updateSeatMapAction",
"summary": "Update Seat Map",
"tags": [
"Seating"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "seatMapId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertSeatMapRequest"
}
}
}
},
"responses": {
"200": {
"description": "`SeatMapResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SeatMapResource"
}
},
"required": [
"data"
]
}
}
}
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"403": {
"description": "Access denied",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"delete": {
"operationId": "actions.deleteSeatMapAction",
"summary": "Delete Seat Map",
"tags": [
"Seating"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "seatMapId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/seat-map": {
"get": {
"operationId": "actions.getEventSeatMapAction",
"summary": "Get Event Seat Map",
"tags": [
"Seating"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`EventSeatMapResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EventSeatMapResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"post": {
"operationId": "actions.attachEventSeatMapAction",
"summary": "Attach Event Seat Map",
"tags": [
"Seating"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"seat_map_id": {
"type": "integer"
}
},
"required": [
"seat_map_id"
]
}
}
}
},
"responses": {
"201": {
"description": "`EventSeatMapResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EventSeatMapResource"
}
},
"required": [
"data"
]
}
}
}
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"403": {
"description": "Access denied",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"delete": {
"operationId": "actions.detachEventSeatMapAction",
"summary": "Detach Event Seat Map",
"tags": [
"Seating"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/seat-map/layout": {
"put": {
"operationId": "actions.updateEventSeatMapLayoutAction",
"summary": "Update Event Seat Map Layout",
"tags": [
"Seating"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateEventSeatMapLayoutRequest"
}
}
}
},
"responses": {
"200": {
"description": "`EventSeatMapResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EventSeatMapResource"
}
},
"required": [
"data"
]
}
}
}
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
},
{
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": false,
"minItems": 0,
"maxItems": 0
},
"requires_relabel_confirmation": {
"type": "boolean"
},
"relabelled_seat_labels": {
"type": "string"
}
},
"required": [
"message",
"errors",
"requires_relabel_confirmation",
"relabelled_seat_labels"
]
}
]
}
}
}
},
"403": {
"description": "Access denied",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/seat-map/band-products": {
"put": {
"operationId": "actions.updateEventSeatMapBandProductsAction",
"summary": "Update Event Seat Map Band Products",
"tags": [
"Seating"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateEventSeatMapBandProductsRequest"
}
}
}
},
"responses": {
"200": {
"description": "`EventSeatMapResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EventSeatMapResource"
}
},
"required": [
"data"
]
}
}
}
},
"403": {
"description": "Access denied",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/seat-map/rules": {
"put": {
"operationId": "actions.updateEventSeatMapRulesAction",
"summary": "Update Event Seat Map Rules",
"tags": [
"Seating"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"prevent_orphan_seats": {
"type": "boolean"
},
"max_seats_per_order": {
"type": [
"integer",
"null"
],
"minimum": 1,
"maximum": 100
},
"allow_seat_change": {
"type": "boolean"
}
},
"required": [
"prevent_orphan_seats",
"max_seats_per_order",
"allow_seat_change"
]
}
}
}
},
"responses": {
"200": {
"description": "`EventSeatMapResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EventSeatMapResource"
}
},
"required": [
"data"
]
}
}
}
},
"403": {
"description": "Access denied",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/seat-map/sync-from-source": {
"post": {
"operationId": "actions.syncEventSeatMapFromSourceAction",
"summary": "Sync Event Seat Map From Source",
"tags": [
"Seating"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"dry_run": {
"type": "boolean"
}
},
"required": [
"dry_run"
]
}
}
}
},
"responses": {
"200": {
"description": "`SeatMapDiffResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SeatMapDiffResource"
}
},
"required": [
"data"
]
}
}
}
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"403": {
"description": "Access denied",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/occurrences/{occurrenceId}/occupied-seats": {
"get": {
"operationId": "actions.getOccupiedSeatsAction",
"summary": "Get Occupied Seats",
"tags": [
"Seating"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "occurrenceId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Array of `OccupiedSeatResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OccupiedSeatResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/seat-blocks": {
"post": {
"operationId": "actions.blockSeatsAction",
"summary": "Block Seats",
"tags": [
"Seating"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SeatBlockRequest"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"blocked": {
"type": "integer",
"minimum": 0
},
"skipped": {
"type": "array",
"items": {}
}
},
"required": [
"blocked",
"skipped"
]
}
},
"required": [
"data"
]
}
}
}
},
"403": {
"description": "Access denied",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error overview."
}
},
"required": [
"message"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/seat-blocks/release": {
"post": {
"operationId": "actions.releaseSeatBlocksAction",
"summary": "Release Seat Blocks",
"tags": [
"Seating"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SeatBlockRequest"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"released": {
"type": "integer"
}
},
"required": [
"released"
]
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/attendees/{attendeeId}/seat": {
"put": {
"operationId": "actions.moveAttendeeSeatAction",
"summary": "Move Attendee Seat",
"tags": [
"Seating"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "attendeeId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MoveAttendeeSeatRequest"
}
}
}
},
"responses": {
"200": {
"description": "`AttendeeResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AttendeeResource"
}
},
"required": [
"data"
]
}
}
}
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "object",
"properties": {
"unavailable_seat_uids": {
"type": "string"
}
},
"required": [
"unavailable_seat_uids"
]
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/public/events/{eventId}/seat-map": {
"get": {
"operationId": "public.getEventSeatMapPublicAction",
"summary": "Get Event Seat Map (public)",
"tags": [
"Seating / Public"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`EventSeatMapResourcePublic`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/EventSeatMapResourcePublic"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"description": ""
}
},
"security": []
}
},
"/public/events/{eventId}/occurrences/{occurrenceId}/seat-availability": {
"get": {
"operationId": "public.getSeatAvailabilityPublicAction",
"summary": "Get Seat Availability (public)",
"tags": [
"Seating / Public"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "occurrenceId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`SeatAvailabilityResourcePublic`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/SeatAvailabilityResourcePublic"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"description": ""
},
"429": {
"description": "Too many requests. Retry once the rate limit window resets.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
},
"security": []
}
},
"/public/events/{eventId}/occurrences/{occurrenceId}/best-available-seats": {
"get": {
"operationId": "public.getBestAvailableSeatsPublicAction",
"summary": "Get Best Available Seats (public)",
"tags": [
"Seating / Public"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "occurrenceId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "product_id",
"in": "query",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "quantity",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 20
}
},
{
"name": "accessible",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "exclude[]",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"maxLength": 24
}
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"seat_uids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"seat_uids"
]
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"description": ""
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"429": {
"description": "Too many requests. Retry once the rate limit window resets.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
},
"security": []
}
},
"/public/events/{eventId}/order/{orderShortId}/attendees/{attendeeShortId}/seat": {
"put": {
"operationId": "public.changeAttendeeSeatPublicAction",
"summary": "Change Attendee Seat (public)",
"tags": [
"Seating / Public"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "orderShortId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "attendeeShortId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MoveAttendeeSeatRequest"
}
}
}
},
"responses": {
"200": {
"description": "`AttendeeResourcePublic`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/AttendeeResourcePublic"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "object",
"properties": {
"unavailable_seat_uids": {
"type": "string"
}
},
"required": [
"unavailable_seat_uids"
]
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"429": {
"description": "Too many requests. Retry once the rate limit window resets.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
},
"security": []
}
},
"/public/events/{eventId}/order/{orderShortId}/resend-confirmation": {
"post": {
"operationId": "selfService.resendOrderConfirmationPublicAction",
"summary": "Resend Order Confirmation (public)",
"tags": [
"Self Service"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "orderShortId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"const": "Order confirmation resent successfully"
}
},
"required": [
"message"
]
}
}
}
},
"429": {
"description": "Too many requests. Retry once the rate limit window resets.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
},
"security": []
}
},
"/public/events/{eventId}/order/{orderShortId}/attendees/{attendeeShortId}": {
"patch": {
"operationId": "selfService.editAttendeePublicAction",
"summary": "Edit Attendee (public)",
"tags": [
"Self Service"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "orderShortId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "attendeeShortId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EditAttendeePublicRequest"
}
}
}
},
"responses": {
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"const": "Attendee updated successfully"
},
"new_short_id": {
"type": "string"
}
},
"required": [
"message",
"new_short_id"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"429": {
"description": "Too many requests. Retry once the rate limit window resets.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
},
"security": []
}
},
"/public/events/{eventId}/order/{orderShortId}/attendees/{attendeeShortId}/resend-ticket": {
"post": {
"operationId": "selfService.resendAttendeeTicketPublicAction",
"summary": "Resend Attendee Ticket (public)",
"tags": [
"Self Service"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "orderShortId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "attendeeShortId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"const": "Ticket resent successfully"
}
},
"required": [
"message"
]
}
}
}
},
"429": {
"description": "Too many requests. Retry once the rate limit window resets.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
},
"security": []
}
},
"/accounts/{accountId}/taxes-and-fees": {
"post": {
"operationId": "taxesAndFees.createTaxOrFeeAction",
"summary": "Create Tax Or Fee",
"tags": [
"Taxes And Fees"
],
"parameters": [
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTaxOrFeeRequest"
}
}
}
},
"responses": {
"200": {
"description": "`TaxAndFeeResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaxAndFeeResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"get": {
"operationId": "taxesAndFees.getTaxOrFeeAction",
"summary": "Get Tax Or Fee",
"tags": [
"Taxes And Fees"
],
"parameters": [
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Array of `TaxAndFeeResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TaxAndFeeResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/accounts/{accountId}/taxes-and-fees/{taxOrFeeId}": {
"put": {
"operationId": "taxesAndFees.editTaxOrFeeAction",
"summary": "Edit Tax Or Fee",
"tags": [
"Taxes And Fees"
],
"parameters": [
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "taxOrFeeId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTaxOrFeeRequest"
}
}
}
},
"responses": {
"200": {
"description": "`TaxAndFeeResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/TaxAndFeeResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"delete": {
"operationId": "taxesAndFees.deleteTaxOrFeeAction",
"summary": "Delete Tax Or Fee",
"tags": [
"Taxes And Fees"
],
"parameters": [
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "taxOrFeeId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/public/ticket-lookup": {
"post": {
"operationId": "ticketLookup.sendTicketLookupEmailAction",
"summary": "Send Ticket Lookup Email (public)",
"tags": [
"Ticket Lookup"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SendTicketLookupEmailRequest"
}
}
}
},
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"const": "If you have tickets associated with this email, we will send you an email with the details."
}
},
"required": [
"message"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"429": {
"description": "Too many requests. Retry once the rate limit window resets.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
},
"security": []
}
},
"/public/ticket-lookup/{token}": {
"get": {
"operationId": "ticketLookup.getOrdersByLookupTokenAction",
"summary": "Get Orders By Lookup Token (public)",
"tags": [
"Ticket Lookup"
],
"parameters": [
{
"name": "token",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"200": {
"description": "Array of `OrderResourcePublic`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderResourcePublic"
}
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
},
"security": []
}
},
"/users/me": {
"get": {
"operationId": "users.getMeAction",
"summary": "Get Me",
"tags": [
"Users"
],
"responses": {
"200": {
"description": "`MeResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/MeResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/waitlist": {
"get": {
"operationId": "organizer.getWaitlistEntriesAction",
"summary": "Get Waitlist Entries",
"tags": [
"Waitlist / Organizer"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"default": 1
}
},
{
"name": "per_page",
"in": "query",
"schema": {
"type": "integer",
"default": 25
}
},
{
"name": "sort_by",
"in": "query",
"description": "Sortable fields are listed in the response `meta.allowed_sorts`.",
"schema": {
"type": "string"
}
},
{
"name": "sort_direction",
"in": "query",
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
{
"name": "query",
"in": "query",
"description": "Search term used to filter the results.",
"schema": {
"type": "string"
}
},
{
"name": "filter_fields",
"in": "query",
"description": "Filters in the form `filter_fields[field][operator]=value`. Filterable fields are listed in the response `meta.allowed_filter_fields`.",
"style": "deepObject",
"schema": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"explode": true
}
],
"responses": {
"200": {
"description": "Array of `WaitlistEntryResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WaitlistEntryResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/waitlist/stats": {
"get": {
"operationId": "organizer.getWaitlistStatsAction",
"summary": "Get Waitlist Stats",
"tags": [
"Waitlist / Organizer"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "event_occurrence_id",
"in": "query",
"schema": {
"type": [
"integer",
"null"
]
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"total": {
"type": "integer"
},
"waiting": {
"type": "integer"
},
"offered": {
"type": "integer"
},
"purchased": {
"type": "integer"
},
"cancelled": {
"type": "integer"
},
"expired": {
"type": "integer"
},
"products": {
"type": "array",
"items": {}
}
},
"required": [
"total",
"waiting",
"offered",
"purchased",
"cancelled",
"expired",
"products"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/waitlist/offer-next": {
"post": {
"operationId": "organizer.offerWaitlistEntryAction",
"summary": "Offer Waitlist Entry",
"tags": [
"Waitlist / Organizer"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OfferWaitlistEntryRequest"
}
}
}
},
"responses": {
"200": {
"description": "Array of `WaitlistEntryResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WaitlistEntryResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/waitlist/{entryId}": {
"delete": {
"operationId": "organizer.cancelWaitlistEntryAction",
"summary": "Cancel Waitlist Entry",
"tags": [
"Waitlist / Organizer"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "entryId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/public/events/{eventId}/waitlist": {
"post": {
"operationId": "public.createWaitlistEntryActionPublic",
"summary": "Create Waitlist Entry (public)",
"tags": [
"Waitlist / Public"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/CreateWaitlistEntryRequest"
},
{
"type": "object",
"properties": {
"locale": {
"type": "string",
"default": "en"
}
}
}
]
}
}
}
},
"responses": {
"201": {
"description": "`WaitlistEntryResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/WaitlistEntryResource"
}
},
"required": [
"data"
]
}
}
}
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"429": {
"description": "Too many requests. Retry once the rate limit window resets.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
},
"security": []
}
},
"/public/events/{eventId}/waitlist/{token}": {
"delete": {
"operationId": "public.cancelWaitlistEntryActionPublic",
"summary": "Cancel Waitlist Entry (public)",
"tags": [
"Waitlist / Public"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "token",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"409": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"404": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"errors": {
"type": "array",
"items": {}
}
},
"required": [
"message",
"errors"
]
}
}
}
},
"429": {
"description": "Too many requests. Retry once the rate limit window resets.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
},
"security": []
}
},
"/events/{eventId}/webhooks": {
"post": {
"operationId": "webhooks.createWebhookAction",
"summary": "Create Webhook",
"tags": [
"Webhooks"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertWebhookRequest"
}
}
}
},
"responses": {
"200": {
"description": "`WebhookResourceWithSecret`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/WebhookResourceWithSecret"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"get": {
"operationId": "webhooks.getWebhooksAction",
"summary": "Get Webhooks",
"tags": [
"Webhooks"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Array of `WebhookResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/webhooks/{webhookId}": {
"put": {
"operationId": "webhooks.editWebhookAction",
"summary": "Edit Webhook",
"tags": [
"Webhooks"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "webhookId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertWebhookRequest"
}
}
}
},
"responses": {
"200": {
"description": "`WebhookResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/WebhookResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"get": {
"operationId": "webhooks.getWebhookAction",
"summary": "Get Webhook",
"tags": [
"Webhooks"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "webhookId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "`WebhookResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/WebhookResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"delete": {
"operationId": "webhooks.deleteWebhookAction",
"summary": "Delete Webhook",
"tags": [
"Webhooks"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "webhookId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/webhooks/{webhookId}/logs": {
"get": {
"operationId": "webhooks.getWebhookLogsAction",
"summary": "Get Webhook Logs",
"tags": [
"Webhooks"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "webhookId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Array of `WebhookLogResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookLogResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/organizers/{organizerId}/widgets": {
"get": {
"operationId": "widgets.getOrganizerWidgetsAction",
"summary": "Get Organizer Widgets",
"tags": [
"Widgets"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Array of `WidgetResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WidgetResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"post": {
"operationId": "widgets.createOrganizerWidgetAction",
"summary": "Create Organizer Widget",
"tags": [
"Widgets"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertOrganizerWidgetRequest"
}
}
}
},
"responses": {
"200": {
"description": "`WidgetResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/WidgetResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/organizers/{organizerId}/widgets/{widgetId}": {
"put": {
"operationId": "widgets.updateOrganizerWidgetAction",
"summary": "Update Organizer Widget",
"tags": [
"Widgets"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "widgetId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertOrganizerWidgetRequest"
}
}
}
},
"responses": {
"200": {
"description": "`WidgetResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/WidgetResource"
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"delete": {
"operationId": "widgets.deleteOrganizerWidgetAction",
"summary": "Delete Organizer Widget",
"tags": [
"Widgets"
],
"parameters": [
{
"name": "organizerId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "widgetId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/widgets": {
"get": {
"operationId": "widgets.getEventWidgetsAction",
"summary": "Get Event Widgets",
"tags": [
"Widgets"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Array of `WidgetResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WidgetResource"
}
}
},
"required": [
"data"
]
}
}
}
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"post": {
"operationId": "widgets.createEventWidgetAction",
"summary": "Create Event Widget",
"tags": [
"Widgets"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertEventWidgetRequest"
}
}
}
},
"responses": {
"200": {
"description": "`WidgetResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/WidgetResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/events/{eventId}/widgets/{widgetId}": {
"put": {
"operationId": "widgets.updateEventWidgetAction",
"summary": "Update Event Widget",
"tags": [
"Widgets"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "widgetId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertEventWidgetRequest"
}
}
}
},
"responses": {
"200": {
"description": "`WidgetResource`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/WidgetResource"
}
},
"required": [
"data"
]
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationException"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
},
"delete": {
"operationId": "widgets.deleteEventWidgetAction",
"summary": "Delete Event Widget",
"tags": [
"Widgets"
],
"parameters": [
{
"name": "eventId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "widgetId",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "No content"
},
"401": {
"$ref": "#/components/responses/AuthenticationException"
},
"403": {
"description": "The authenticated user is not allowed to perform this action.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
},
"404": {
"description": "The requested resource was not found.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
}
}
},
"/public/widgets/{widgetShortId}": {
"get": {
"operationId": "widgets.getWidgetPublicAction",
"summary": "Get Widget (public)",
"tags": [
"Widgets"
],
"parameters": [
{
"name": "widgetShortId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "`WidgetResourcePublic`",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/WidgetResourcePublic"
}
},
"required": [
"data"
]
}
}
}
},
"404": {
"description": ""
},
"429": {
"description": "Too many requests. Retry once the rate limit window resets.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
}
}
}
}
},
"security": []
}
}
},
"components": {
"securitySchemes": {
"http": {
"type": "http",
"description": "An API key (`hie_…`) or a session token from `POST /auth/login`.",
"scheme": "bearer"
}
},
"schemas": {
"AccountDeletionRequestResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"status": {
"type": "string"
},
"initiated_by": {
"type": "string"
},
"expected_outcome": {
"type": [
"string",
"null"
]
},
"scheduled_deletion_at": {
"type": "string"
},
"cancelled_at": {
"type": [
"string",
"null"
]
},
"requested_at": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"status",
"initiated_by",
"expected_outcome",
"scheduled_deletion_at",
"cancelled_at",
"requested_at"
],
"title": "AccountDeletionRequestResource"
},
"AccountResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"currency_code": {
"type": "string"
},
"timezone": {
"type": [
"string",
"null"
]
},
"updated_at": {
"type": [
"string",
"null"
]
},
"require_two_factor_authentication": {
"type": "boolean"
},
"is_account_email_confirmed": {
"type": "boolean"
},
"is_saas_mode_enabled": {
"type": "string"
},
"requires_manual_verification": {
"type": "string"
},
"deletion_request": {
"anyOf": [
{
"$ref": "#/components/schemas/AccountDeletionRequestResource"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"currency_code",
"timezone",
"updated_at",
"require_two_factor_authentication",
"is_account_email_confirmed",
"is_saas_mode_enabled",
"requires_manual_verification",
"deletion_request"
],
"title": "AccountResource"
},
"AffiliateResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"event_id": {
"type": "integer"
},
"account_id": {
"type": "integer"
},
"name": {
"type": "string"
},
"code": {
"type": "string"
},
"email": {
"type": [
"string",
"null"
]
},
"total_sales": {
"type": "integer"
},
"total_sales_gross": {
"type": "number"
},
"status": {
"type": "string"
},
"created_at": {
"type": [
"string",
"null"
]
},
"updated_at": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"event_id",
"account_id",
"name",
"code",
"email",
"total_sales",
"status",
"created_at",
"updated_at"
],
"title": "AffiliateResource"
},
"AttendeeCheckInPublicResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"short_id": {
"type": "string"
},
"check_in_list_id": {
"type": "integer"
},
"attendee_id": {
"type": "integer"
},
"checked_in_at": {
"type": [
"string",
"null"
]
},
"order_id": {
"type": [
"integer",
"null"
]
},
"event_occurrence_id": {
"type": [
"integer",
"null"
]
}
},
"required": [
"id",
"short_id",
"check_in_list_id",
"attendee_id",
"checked_in_at",
"order_id",
"event_occurrence_id"
],
"title": "AttendeeCheckInPublicResource"
},
"AttendeeCheckInResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"attendee_id": {
"type": "integer"
},
"check_in_list_id": {
"type": "integer"
},
"product_id": {
"type": "integer"
},
"event_id": {
"type": "integer"
},
"event_occurrence_id": {
"type": [
"integer",
"null"
]
},
"short_id": {
"type": "string"
},
"created_at": {
"type": [
"string",
"null"
]
},
"check_in_list": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"expires_at": {
"type": [
"string",
"null"
]
},
"activates_at": {
"type": [
"string",
"null"
]
},
"short_id": {
"type": "string"
},
"is_system_default": {
"type": "boolean"
},
"event_occurrence_id": {
"type": [
"integer",
"null"
]
},
"total_attendees": {
"type": [
"integer",
"null"
]
},
"checked_in_attendees": {
"type": [
"integer",
"null"
]
},
"public_show_attendee_notes": {
"type": "boolean"
},
"public_show_question_answers": {
"type": "boolean"
},
"public_show_order_details": {
"type": "boolean"
},
"is_expired": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"event_occurrence": {
"anyOf": [
{
"$ref": "#/components/schemas/EventOccurrenceResource"
},
{
"type": "null"
}
]
},
"products": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/ProductResource"
}
}
},
"required": [
"id",
"name",
"description",
"expires_at",
"activates_at",
"short_id",
"is_system_default",
"event_occurrence_id",
"total_attendees",
"checked_in_attendees",
"public_show_attendee_notes",
"public_show_question_answers",
"public_show_order_details"
]
},
"attendee": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"order_id": {
"type": "integer"
},
"product_id": {
"type": "integer"
},
"product_price_id": {
"type": "integer"
},
"event_id": {
"type": "integer"
},
"email": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"AWAITING_PAYMENT",
"CANCELLED"
]
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"public_id": {
"type": "string"
},
"short_id": {
"type": "string"
},
"event_occurrence_id": {
"type": [
"integer",
"null"
]
},
"seat_uid": {
"type": [
"string",
"null"
]
},
"seat_label": {
"type": [
"string",
"null"
]
},
"locale": {
"type": "string"
},
"notes": {
"type": [
"string",
"null"
]
},
"event_occurrence": {
"anyOf": [
{
"$ref": "#/components/schemas/EventOccurrenceResource"
},
{
"type": "null"
}
]
},
"product": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductResource"
},
{
"type": "null"
}
]
},
"check_ins": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/AttendeeCheckInResource"
}
},
"order": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderResource"
},
{
"type": "null"
}
]
},
"question_answers": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/QuestionAnswerViewResource"
}
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"order_id",
"product_id",
"product_price_id",
"event_id",
"email",
"status",
"first_name",
"last_name",
"public_id",
"short_id",
"event_occurrence_id",
"seat_uid",
"seat_label",
"locale",
"notes",
"created_at",
"updated_at"
]
}
},
"required": [
"id",
"attendee_id",
"check_in_list_id",
"product_id",
"event_id",
"event_occurrence_id",
"short_id",
"created_at"
],
"title": "AttendeeCheckInResource"
},
"AttendeeDetailPublicResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"public_id": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"status": {
"type": "string"
},
"seat_label": {
"type": [
"string",
"null"
]
},
"product_id": {
"type": "integer"
},
"product_title": {
"type": [
"string",
"null"
]
},
"event_occurrence": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer"
},
"event_id": {
"type": "integer"
},
"start_date": {
"type": "string"
},
"end_date": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string"
},
"capacity": {
"type": [
"integer",
"null"
]
},
"available_capacity": {
"type": [
"integer",
"null"
]
},
"label": {
"type": [
"string",
"null"
]
},
"is_past": {
"type": "boolean"
},
"is_future": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"event_location": {
"anyOf": [
{
"$ref": "#/components/schemas/EventLocationResourcePublic"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"event_id",
"start_date",
"end_date",
"status",
"label",
"is_past",
"is_future",
"is_active"
]
},
"check_ins": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"short_id": {
"type": "string"
},
"check_in_list_id": {
"type": "integer"
},
"attendee_id": {
"type": "integer"
},
"checked_in_at": {
"type": [
"string",
"null"
]
},
"order_id": {
"type": [
"integer",
"null"
]
},
"event_occurrence_id": {
"type": [
"integer",
"null"
]
}
},
"required": [
"id",
"short_id",
"check_in_list_id",
"attendee_id",
"checked_in_at",
"order_id",
"event_occurrence_id"
]
}
},
"visibility": {
"type": "object",
"properties": {
"notes": {
"type": "boolean"
},
"question_answers": {
"type": "boolean"
},
"order_details": {
"type": "boolean"
}
},
"required": [
"notes",
"question_answers",
"order_details"
]
},
"notes": {
"type": [
"string",
"null"
]
},
"question_answers": {
"type": "array",
"items": {}
},
"email": {
"type": [
"string",
"null"
]
},
"order": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"public_id": {
"type": "string"
},
"status": {
"type": "string"
},
"first_name": {
"type": [
"string",
"null"
]
},
"last_name": {
"type": [
"string",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": "string"
}
},
"required": [
"id",
"public_id",
"status",
"first_name",
"last_name",
"email",
"created_at"
]
}
},
"required": [
"id",
"public_id",
"first_name",
"last_name",
"status",
"seat_label",
"product_id",
"product_title",
"event_occurrence",
"check_ins",
"visibility",
"notes",
"question_answers",
"email",
"order"
],
"title": "AttendeeDetailPublicResource"
},
"AttendeeResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"order_id": {
"type": "integer"
},
"product_id": {
"type": "integer"
},
"product_price_id": {
"type": "integer"
},
"event_id": {
"type": "integer"
},
"email": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"AWAITING_PAYMENT",
"CANCELLED"
]
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"public_id": {
"type": "string"
},
"short_id": {
"type": "string"
},
"event_occurrence_id": {
"type": [
"integer",
"null"
]
},
"seat_uid": {
"type": [
"string",
"null"
]
},
"seat_label": {
"type": [
"string",
"null"
]
},
"locale": {
"type": "string"
},
"notes": {
"type": [
"string",
"null"
]
},
"event_occurrence": {
"anyOf": [
{
"$ref": "#/components/schemas/EventOccurrenceResource"
},
{
"type": "null"
}
]
},
"product": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductResource"
},
{
"type": "null"
}
]
},
"check_ins": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/AttendeeCheckInResource"
}
},
"order": {
"anyOf": [
{
"$ref": "#/components/schemas/OrderResource"
},
{
"type": "null"
}
]
},
"question_answers": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/QuestionAnswerViewResource"
}
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
}
},
"required": [
"id",
"order_id",
"product_id",
"product_price_id",
"event_id",
"email",
"status",
"first_name",
"last_name",
"public_id",
"short_id",
"event_occurrence_id",
"seat_uid",
"seat_label",
"locale",
"notes",
"created_at",
"updated_at"
],
"title": "AttendeeResource"
},
"AttendeeResourcePublic": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"email": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"AWAITING_PAYMENT",
"CANCELLED"
]
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"public_id": {
"type": "string"
},
"short_id": {
"type": "string"
},
"seat_uid": {
"type": [
"string",
"null"
]
},
"seat_label": {
"type": [
"string",
"null"
]
},
"product_id": {
"type": "integer"
},
"product_price_id": {
"type": "integer"
},
"product": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductMinimalResourcePublic"
},
{
"type": "null"
}
]
},
"event_occurrence_id": {
"type": [
"integer",
"null"
]
},
"event_occurrence": {
"anyOf": [
{
"$ref": "#/components/schemas/EventOccurrenceResourcePublic"
},
{
"type": "null"
}
]
},
"locale": {
"type": "string"
},
"is_checked_in": {
"type": "boolean"
}
},
"required": [
"id",
"email",
"status",
"first_name",
"last_name",
"public_id",
"short_id",
"seat_uid",
"seat_label",
"product_id",
"product_price_id",
"event_occurrence_id",
"locale"
],
"title": "AttendeeResourcePublic"
},
"AttendeeWithCheckInPublicResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"public_id": {
"type": "string"
},
"seat_label": {
"type": [
"string",
"null"
]
},
"product_id": {
"type": "integer"
},
"product_price_id": {
"type": "integer"
},
"status": {
"type": "string"
},
"locale": {
"type": "string"
},
"order_id": {
"type": "integer"
},
"event_occurrence_id": {
"type": [
"integer",
"null"
]
},
"event_occurrence": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer"
},
"event_id": {
"type": "integer"
},
"start_date": {
"type": "string"
},
"end_date": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string"
},
"capacity": {
"type": [
"integer",
"null"
]
},
"available_capacity": {
"type": [
"integer",
"null"
]
},
"label": {
"type": [
"string",
"null"
]
},
"is_past": {
"type": "boolean"
},
"is_future": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"event_location": {
"anyOf": [
{
"$ref": "#/components/schemas/EventLocationResourcePublic"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"event_id",
"start_date",
"end_date",
"status",
"label",
"is_past",
"is_future",
"is_active"
]
},
"check_in": {
"anyOf": [
{
"$ref": "#/components/schemas/AttendeeCheckInPublicResource"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"first_name",
"last_name",
"public_id",
"seat_label",
"product_id",
"product_price_id",
"status",
"locale",
"order_id",
"event_occurrence_id",
"event_occurrence"
],
"title": "AttendeeWithCheckInPublicResource"
},
"BoxOfficeResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"short_id": {
"type": "string"
},
"event_id": {
"type": "integer"
},
"event_occurrence_id": {
"type": [
"integer",
"null"
]
},
"check_in_list_id": {
"type": [
"integer",
"null"
]
},
"has_pin": {
"type": "boolean"
},
"allow_price_override": {
"type": "boolean"
},
"allow_discounts": {
"type": "boolean"
},
"collect_order_questions": {
"type": "boolean"
},
"is_system_default": {
"type": "boolean"
},
"activates_at": {
"type": [
"string",
"null"
]
},
"expires_at": {
"type": [
"string",
"null"
]
},
"sales_count": {
"type": "integer"
},
"gross_sales": {
"type": "number"
},
"is_expired": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"currency": {
"type": "string"
},
"event_occurrence": {
"anyOf": [
{
"$ref": "#/components/schemas/EventOccurrenceResource"
},
{
"type": "null"
}
]
},
"check_in_list": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"short_id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"short_id",
"name"
]
},
"products": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/ProductResource"
}
}
},
"required": [
"id",
"name",
"description",
"short_id",
"event_id",
"event_occurrence_id",
"check_in_list_id",
"has_pin",
"allow_price_override",
"allow_discounts",
"collect_order_questions",
"is_system_default",
"activates_at",
"expires_at",
"sales_count"
],
"title": "BoxOfficeResource"
},
"BoxOfficeStatsResource": {
"type": "object",
"properties": {
"currency": {
"type": "string"
},
"orders": {
"type": "integer"
},
"gross": {
"type": "number"
},
"refunded": {
"type": "number"
},
"by_tender": {
"type": "array",
"items": {}
},
"by_operator": {
"type": "array",
"items": {}
},
"by_day": {
"type": "array",
"items": {}
}
},
"required": [
"currency",
"orders",
"gross",
"refunded",
"by_tender",
"by_operator",
"by_day"
],
"title": "BoxOfficeStatsResource"
},
"BoxOfficeWithPinResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"short_id": {
"type": "string"
},
"event_id": {
"type": "integer"
},
"event_occurrence_id": {
"type": [
"integer",
"null"
]
},
"check_in_list_id": {
"type": [
"integer",
"null"
]
},
"has_pin": {
"type": "boolean"
},
"allow_price_override": {
"type": "boolean"
},
"allow_discounts": {
"type": "boolean"
},
"collect_order_questions": {
"type": "boolean"
},
"is_system_default": {
"type": "boolean"
},
"activates_at": {
"type": [
"string",
"null"
]
},
"expires_at": {
"type": [
"string",
"null"
]
},
"sales_count": {
"type": "integer"
},
"gross_sales": {
"type": "number"
},
"products": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/ProductResource"
}
},
"event_occurrence": {
"anyOf": [
{
"$ref": "#/components/schemas/EventOccurrenceResource"
},
{
"type": "null"
}
]
},
"check_in_list": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"short_id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"short_id",
"name"
]
},
"pin": {
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"short_id",
"event_id",
"event_occurrence_id",
"check_in_list_id",
"has_pin",
"allow_price_override",
"allow_discounts",
"collect_order_questions",
"is_system_default",
"activates_at",
"expires_at",
"sales_count",
"pin"
],
"title": "BoxOfficeWithPinResource"
},
"BulkUpdateOccurrencesRequest": {
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"update",
"cancel",
"delete"
]
},
"start_time_shift": {
"type": [
"integer",
"null"
],
"minimum": -525600,
"maximum": 525600
},
"end_time_shift": {
"type": [
"integer",
"null"
],
"minimum": -525600,
"maximum": 525600
},
"capacity": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"clear_capacity": {
"type": [
"boolean",
"null"
]
},
"future_only": {
"type": [
"boolean",
"null"
]
},
"skip_overridden": {
"type": [
"boolean",
"null"
]
},
"refund_orders": {
"type": [
"boolean",
"null"
]
},
"apply_to_all": {
"type": [
"boolean",
"null"
]
},
"occurrence_ids": {
"type": "array",
"items": {
"type": "integer"
}
},
"label": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"clear_label": {
"type": [
"boolean",
"null"
]
},
"duration_minutes": {
"type": [
"integer",
"null"
],
"minimum": 1,
"maximum": 10080
},
"event_location": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"IN_PERSON",
"ONLINE"
]
},
"location_id": {
"type": [
"integer",
"null"
]
},
"online_event_connection_details": {
"type": [
"string",
"null"
],
"maxLength": 10000
}
}
},
"clear_event_location": {
"type": "boolean"
}
},
"required": [
"action"
],
"title": "BulkUpdateOccurrencesRequest"
},
"CancelOccurrenceRequest": {
"type": "object",
"properties": {
"refund_orders": {
"type": [
"boolean",
"null"
]
}
},
"title": "CancelOccurrenceRequest"
},
"CapacityAssignmentResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"capacity": {
"type": [
"integer",
"null"
]
},
"used_capacity": {
"type": "integer"
},
"percentage_used": {
"type": "number"
},
"applies_to": {
"type": "string"
},
"status": {
"type": "string"
},
"event_id": {
"type": "integer"
},
"products": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"title": {
"type": "string"
}
},
"required": [
"id",
"title"
]
}
}
},
"required": [
"id",
"name",
"capacity",
"used_capacity",
"percentage_used",
"applies_to",
"status",
"event_id"
],
"title": "CapacityAssignmentResource"
},
"CheckInAttendeeRequest": {
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"check_in",
"check_out"
]
}
},
"required": [
"action"
],
"title": "CheckInAttendeeRequest"
},
"CheckInListResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"expires_at": {
"type": [
"string",
"null"
]
},
"activates_at": {
"type": [
"string",
"null"
]
},
"short_id": {
"type": "string"
},
"is_system_default": {
"type": "boolean"
},
"event_occurrence_id": {
"type": [
"integer",
"null"
]
},
"total_attendees": {
"type": [
"integer",
"null"
]
},
"checked_in_attendees": {
"type": [
"integer",
"null"
]
},
"public_show_attendee_notes": {
"type": "boolean"
},
"public_show_question_answers": {
"type": "boolean"
},
"public_show_order_details": {
"type": "boolean"
},
"is_expired": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"event_occurrence": {
"anyOf": [
{
"$ref": "#/components/schemas/EventOccurrenceResource"
},
{
"type": "null"
}
]
},
"products": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/ProductResource"
}
}
},
"required": [
"id",
"name",
"description",
"expires_at",
"activates_at",
"short_id",
"is_system_default",
"event_occurrence_id",
"total_attendees",
"checked_in_attendees",
"public_show_attendee_notes",
"public_show_question_answers",
"public_show_order_details"
],
"title": "CheckInListResource"
},
"CheckInListResourcePublic": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"short_id": {
"type": "string"
},
"name": {
"type": "string"
},
"is_system_default": {
"type": "boolean"
},
"event_occurrence_id": {
"type": [
"integer",
"null"
]
},
"event_occurrence": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer"
},
"event_id": {
"type": "integer"
},
"start_date": {
"type": "string"
},
"end_date": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string"
},
"capacity": {
"type": [
"integer",
"null"
]
},
"available_capacity": {
"type": [
"integer",
"null"
]
},
"label": {
"type": [
"string",
"null"
]
},
"is_past": {
"type": "boolean"
},
"is_future": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"event_location": {
"anyOf": [
{
"$ref": "#/components/schemas/EventLocationResourcePublic"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"event_id",
"start_date",
"end_date",
"status",
"label",
"is_past",
"is_future",
"is_active"
]
},
"description": {
"type": [
"string",
"null"
]
},
"expires_at": {
"type": [
"string",
"null"
]
},
"activates_at": {
"type": [
"string",
"null"
]
},
"total_attendees": {
"type": [
"integer",
"null"
]
},
"checked_in_attendees": {
"type": [
"integer",
"null"
]
},
"public_show_attendee_notes": {
"type": "boolean"
},
"public_show_question_answers": {
"type": "boolean"
},
"public_show_order_details": {
"type": "boolean"
},
"is_expired": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"event": {
"anyOf": [
{
"$ref": "#/components/schemas/EventResourcePublic"
},
{
"type": "null"
}
]
},
"event_occurrences": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/EventOccurrenceResourcePublic"
}
},
{
"type": "array",
"items": false,
"minItems": 0,
"maxItems": 0
}
]
},
"products": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/ProductMinimalResourcePublic"
}
}
},
"required": [
"id",
"short_id",
"name",
"is_system_default",
"event_occurrence_id",
"event_occurrence",
"description",
"expires_at",
"activates_at",
"total_attendees",
"checked_in_attendees",
"public_show_attendee_notes",
"public_show_question_answers",
"public_show_order_details"
],
"title": "CheckInListResourcePublic"
},
"CheckInListStatsPublicResource": {
"type": "object",
"properties": {
"total_attendees": {
"type": "integer"
},
"checked_in_attendees": {
"type": "integer"
},
"per_product": {
"type": "array",
"items": {}
},
"recent_check_ins": {
"type": "array",
"items": {}
}
},
"required": [
"total_attendees",
"checked_in_attendees",
"per_product",
"recent_check_ins"
],
"title": "CheckInListStatsPublicResource"
},
"CompleteOrderRequest": {
"type": "object",
"properties": {
"order": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"maxLength": 40
},
"last_name": {
"type": "string",
"maxLength": 40
},
"email": {
"type": "string",
"format": "email"
},
"email_confirmation": {
"type": "string",
"format": "email"
},
"questions": {
"type": "array",
"items": {
"type": "string"
}
},
"address": {
"type": "object",
"properties": {
"address_line_1": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"address_line_2": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"city": {
"type": [
"string",
"null"
],
"maxLength": 85
},
"state_or_region": {
"type": [
"string",
"null"
],
"maxLength": 85
},
"zip_or_postal_code": {
"type": [
"string",
"null"
],
"maxLength": 85
},
"country": {
"type": [
"string",
"null"
],
"maxLength": 2
}
}
}
},
"required": [
"first_name",
"last_name",
"email",
"email_confirmation"
]
},
"products": {
"type": "array",
"items": {
"type": "object",
"properties": {
"seat_uid": {
"type": [
"string",
"null"
],
"maxLength": 24
}
}
}
}
},
"required": [
"order"
],
"title": "CompleteOrderRequest"
},
"CreateAttendeeCheckInPublicRequest": {
"type": "object",
"properties": {
"attendees": {
"type": "array",
"items": {
"type": "object",
"properties": {
"public_id": {
"type": "string"
},
"action": {
"type": "string",
"enum": [
"check-in",
"check-in-and-mark-order-as-paid"
]
}
},
"required": [
"public_id",
"action"
]
},
"minItems": 1
}
},
"required": [
"attendees"
],
"title": "CreateAttendeeCheckInPublicRequest"
},
"CreateAttendeeRequest": {
"type": "object",
"properties": {
"product_id": {
"type": "integer"
},
"event_occurrence_id": {
"type": [
"integer",
"null"
]
},
"product_price_id": {
"type": [
"integer",
"null"
]
},
"seat_uid": {
"type": [
"string",
"null"
],
"maxLength": 24
},
"email": {
"type": "string",
"format": "email"
},
"first_name": {
"type": "string",
"maxLength": 40
},
"last_name": {
"type": "string",
"maxLength": 40
},
"amount_paid": {
"type": "number",
"maximum": 999999999999
},
"send_confirmation_email": {
"type": "boolean"
},
"taxes_and_fees": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tax_or_fee_id": {
"type": "integer"
},
"amount": {
"type": "number",
"maximum": 999999999999
}
},
"required": [
"tax_or_fee_id",
"amount"
]
}
},
"locale": {
"type": "string",
"enum": [
"en",
"de",
"fi",
"fr",
"it",
"nl",
"hu",
"es",
"pt",
"pt-br",
"zh-cn",
"se",
"zh-hk",
"vi",
"tr",
"pl",
"sk",
"el",
"ko",
"ja"
]
},
"override_capacity": {
"type": "boolean"
}
},
"required": [
"product_id",
"email",
"first_name",
"amount_paid",
"send_confirmation_email",
"locale"
],
"title": "CreateAttendeeRequest"
},
"CreateEventImageRequest": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
"description": "Maximum file size: 5120 kilobytes."
},
"type": {
"type": "string",
"enum": [
"EVENT_COVER",
"TICKET_LOGO",
"EVENT_GALLERY",
"EVENT_SPONSOR_LOGO"
]
}
},
"required": [
"image"
],
"title": "CreateEventImageRequest"
},
"CreateEventRequest": {
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 150
},
"description": {
"type": [
"string",
"null"
],
"minLength": 1,
"maxLength": 50000
},
"start_date": {
"type": "string",
"format": "date-time"
},
"end_date": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"type": {
"type": [
"string",
"null"
],
"enum": [
"SINGLE",
"RECURRING",
null
]
},
"timezone": {
"type": "string"
},
"organizer_id": {
"type": "integer"
},
"currency": {
"type": "string",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"AOA",
"ARS",
"AUD",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BWP",
"BYN",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"GBP",
"GEL",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HUF",
"IDR",
"ILS",
"INR",
"IQD",
"ISK",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"STD",
"SVC",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VND",
"VUV",
"WST",
"XCD",
"XAF",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW"
]
},
"category": {
"type": [
"string",
"null"
],
"enum": [
"SOCIAL",
"FAMILY",
"HOBBIES",
"FOOD_DRINK",
"WELLNESS",
"SPIRITUALITY",
"OUTDOORS",
"TOURS",
"CHARITY",
"MUSIC",
"ART",
"COMEDY",
"THEATER",
"FILM",
"DANCE",
"BUSINESS",
"TECH",
"EDUCATION",
"WORKSHOP",
"SPORTS",
"FESTIVAL",
"SEASONAL",
"NIGHTLIFE",
"OTHER",
null
]
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "todo - Revisit the 50k character limit",
"minLength": 1,
"maxLength": 50
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 1000
},
"is_public": {
"type": "boolean"
}
},
"required": [
"name",
"value",
"is_public"
]
}
},
"event_location": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"IN_PERSON",
"ONLINE"
]
},
"location_id": {
"type": [
"integer",
"null"
]
},
"online_event_connection_details": {
"type": [
"string",
"null"
],
"maxLength": 10000
}
}
}
},
"required": [
"title",
"start_date",
"organizer_id"
],
"title": "CreateEventRequest"
},
"CreateImageRequest": {
"type": "object",
"properties": {
"image": {
"type": "string",
"format": "binary",
"contentMediaType": "application/octet-stream",
"description": "Maximum file size: 5120 kilobytes."
},
"image_type": {
"type": "string",
"enum": [
"GENERIC",
"EVENT_COVER",
"TICKET_LOGO",
"EVENT_GALLERY",
"EVENT_SPONSOR_LOGO",
"ORGANIZER_LOGO",
"ORGANIZER_COVER",
"ORGANIZER_GALLERY",
"ORGANIZER_SPONSOR_LOGO",
"PROFILE_IMAGE"
]
},
"entity_id": {
"type": "integer"
}
},
"required": [
"image"
],
"title": "CreateImageRequest"
},
"CreateLineupEntryRequest": {
"type": "object",
"properties": {
"billing_tier": {
"$ref": "#/components/schemas/LineupBillingTier"
},
"role_label": {
"type": [
"string",
"null"
],
"maxLength": 100
},
"is_hidden": {
"type": "boolean"
},
"profile_id": {
"type": "integer"
}
},
"required": [
"billing_tier",
"profile_id"
],
"title": "CreateLineupEntryRequest"
},
"CreateOrderRequest": {
"type": "object",
"properties": {
"products": {
"type": "array",
"items": {
"type": "object",
"properties": {
"product_id": {
"type": "integer"
},
"event_occurrence_id": {
"type": [
"integer",
"null"
]
},
"quantities": {
"type": "array",
"items": {
"type": "object",
"properties": {
"quantity": {
"type": "integer",
"minimum": 0
},
"price_id": {
"type": "integer"
},
"price": {
"type": [
"number",
"null"
],
"minimum": 0
},
"seat_uids": {
"type": [
"array",
"null"
],
"items": {
"type": "string",
"maxLength": 24
},
"maxItems": 100
},
"band_key": {
"type": [
"string",
"null"
],
"maxLength": 24
}
},
"required": [
"quantity",
"price_id"
]
},
"minItems": 1
}
},
"required": [
"product_id",
"quantities"
]
},
"minItems": 1
},
"promo_code": {
"type": [
"string",
"null"
]
},
"affiliate_code": {
"type": [
"string",
"null"
]
},
"widget_id": {
"type": [
"string",
"null"
],
"maxLength": 50
}
},
"required": [
"products"
],
"title": "CreateOrderRequest"
},
"CreateTaxOrFeeRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 255
},
"calculation_type": {
"type": "string",
"enum": [
"PERCENTAGE",
"FIXED"
]
},
"type": {
"type": "string",
"enum": [
"TAX",
"FEE"
]
},
"rate": {
"type": "number"
},
"is_active": {
"type": "boolean"
},
"is_default": {
"type": "boolean"
},
"description": {
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"calculation_type",
"type",
"rate",
"is_active",
"is_default"
],
"title": "CreateTaxOrFeeRequest"
},
"CreateUpdateAffiliateRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 255
},
"code": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]+$",
"maxLength": 50
},
"email": {
"type": [
"string",
"null"
],
"format": "email",
"maxLength": 255
},
"status": {
"type": [
"string",
"null"
],
"enum": [
"ACTIVE",
"INACTIVE",
null
]
}
},
"required": [
"name",
"code"
],
"title": "CreateUpdateAffiliateRequest"
},
"CreateUpdatePromoCodeRequest": {
"type": "object",
"properties": {
"code": {
"type": "string",
"minLength": 2,
"maxLength": 50
},
"applicable_product_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"discount": {
"type": "number",
"minimum": 0
},
"expiry_date": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"max_allowed_usages": {
"type": [
"string",
"null"
],
"maxLength": 9999999
},
"discount_type": {
"type": "string",
"enum": [
"NONE",
"FIXED",
"PERCENTAGE"
]
},
"discount_applies_to": {
"type": "string",
"enum": [
"EACH_PRODUCT",
"ORDER"
]
}
},
"required": [
"code",
"discount_type"
],
"title": "CreateUpdatePromoCodeRequest"
},
"CreateWaitlistEntryRequest": {
"type": "object",
"properties": {
"product_price_id": {
"type": "integer"
},
"event_occurrence_id": {
"type": [
"integer",
"null"
]
},
"email": {
"type": "string",
"format": "email",
"maxLength": 255
},
"first_name": {
"type": "string",
"maxLength": 255
},
"last_name": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"promo_code": {
"type": [
"string",
"null"
],
"maxLength": 255
}
},
"required": [
"product_price_id",
"email",
"first_name"
],
"title": "CreateWaitlistEntryRequest"
},
"DuplicateEventRequest": {
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 150
},
"description": {
"type": [
"string",
"null"
],
"minLength": 1,
"maxLength": 50000
},
"start_date": {
"type": "string",
"format": "date-time"
},
"end_date": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"duplicate_products": {
"type": "boolean"
},
"duplicate_questions": {
"type": "boolean"
},
"duplicate_settings": {
"type": "boolean"
},
"duplicate_promo_codes": {
"type": "boolean"
},
"duplicate_capacity_assignments": {
"type": "boolean"
},
"duplicate_check_in_lists": {
"type": "boolean"
},
"duplicate_event_cover_image": {
"type": "boolean"
},
"duplicate_webhooks": {
"type": "boolean"
},
"duplicate_affiliates": {
"type": "boolean"
},
"duplicate_lineup": {
"type": [
"boolean",
"null"
]
},
"duplicate_ticket_logo": {
"type": "boolean"
},
"duplicate_occurrences": {
"type": [
"boolean",
"null"
]
},
"duplicate_email_templates": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"title",
"start_date",
"duplicate_products",
"duplicate_questions",
"duplicate_settings",
"duplicate_promo_codes",
"duplicate_capacity_assignments",
"duplicate_check_in_lists",
"duplicate_event_cover_image",
"duplicate_webhooks",
"duplicate_affiliates",
"duplicate_ticket_logo"
],
"title": "DuplicateEventRequest"
},
"EditAttendeePublicRequest": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"maxLength": 255
},
"last_name": {
"type": "string",
"maxLength": 255
},
"email": {
"type": "string",
"format": "email",
"maxLength": 255
}
},
"title": "EditAttendeePublicRequest"
},
"EditAttendeeRequest": {
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 100
},
"first_name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"last_name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"product_id": {
"type": "number"
},
"product_price_id": {
"type": "number"
},
"notes": {
"type": [
"string",
"null"
],
"maxLength": 2000
}
},
"required": [
"email",
"first_name",
"last_name",
"product_id",
"product_price_id"
],
"title": "EditAttendeeRequest"
},
"EditOrderPublicRequest": {
"type": "object",
"properties": {
"first_name": {
"type": "string",
"maxLength": 255
},
"last_name": {
"type": "string",
"maxLength": 255
},
"email": {
"type": "string",
"format": "email",
"maxLength": 255
}
},
"title": "EditOrderPublicRequest"
},
"EditOrderRequest": {
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 100
},
"first_name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"last_name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"notes": {
"type": [
"string",
"null"
],
"maxLength": 2000
}
},
"required": [
"email",
"first_name",
"last_name"
],
"title": "EditOrderRequest"
},
"EditQuestionAnswerRequest": {
"type": "object",
"properties": {
"answer": {
"type": [
"string",
"null"
]
}
},
"title": "EditQuestionAnswerRequest"
},
"EmailTemplateResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"account_id": {
"type": "integer"
},
"organizer_id": {
"type": [
"integer",
"null"
]
},
"event_id": {
"type": [
"integer",
"null"
]
},
"template_type": {
"type": "string"
},
"subject": {
"type": "string"
},
"body": {
"type": "string"
},
"cta": {
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {}
},
{
"type": "string"
},
{
"type": "object"
}
]
},
"engine": {
"type": "string"
},
"is_active": {
"type": "boolean"
}
},
"required": [
"id",
"account_id",
"organizer_id",
"event_id",
"template_type",
"subject",
"body",
"cta",
"engine",
"is_active"
],
"title": "EmailTemplateResource"
},
"EmailTemplateType": {
"type": "string",
"enum": [
"order_confirmation",
"attendee_ticket",
"occurrence_cancellation"
],
"title": "EmailTemplateType"
},
"EventLineupResource": {
"type": "object",
"properties": {
"entries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LineupEntryResource"
}
},
"spaces": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventSpaceResource"
}
},
"schedule_items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScheduleItemResource"
}
},
"venues": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"location": {
"anyOf": [
{
"$ref": "#/components/schemas/LocationPublicResource"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"location"
]
}
}
},
"required": [
"entries",
"spaces",
"schedule_items",
"venues"
],
"title": "EventLineupResource"
},
"EventLineupResourcePublic": {
"type": "object",
"properties": {
"entries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LineupEntryResourcePublic"
}
},
"spaces": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventSpaceResourcePublic"
}
},
"schedule_items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScheduleItemResource"
}
}
},
"required": [
"entries",
"spaces",
"schedule_items"
],
"title": "EventLineupResourcePublic"
},
"EventLocationResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string"
},
"location_id": {
"type": [
"integer",
"null"
]
},
"online_event_connection_details": {
"type": [
"string",
"null"
]
},
"location": {
"anyOf": [
{
"$ref": "#/components/schemas/LocationResource"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"type",
"location_id"
],
"title": "EventLocationResource"
},
"EventLocationResourcePublic": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"online_event_connection_details": {
"type": [
"string",
"null"
]
},
"location": {
"anyOf": [
{
"$ref": "#/components/schemas/LocationPublicResource"
},
{
"type": "null"
}
]
}
},
"required": [
"type"
],
"title": "EventLocationResourcePublic"
},
"EventOccurrenceResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"event_id": {
"type": "integer"
},
"short_id": {
"type": "string"
},
"start_date": {
"type": "string"
},
"end_date": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string"
},
"capacity": {
"type": [
"integer",
"null"
]
},
"used_capacity": {
"type": "integer"
},
"available_capacity": {
"type": [
"integer",
"null"
]
},
"label": {
"type": [
"string",
"null"
]
},
"show_available_capacity": {
"type": [
"boolean",
"null"
]
},
"is_overridden": {
"type": "boolean"
},
"is_past": {
"type": "boolean"
},
"is_future": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"event_location": {
"anyOf": [
{
"$ref": "#/components/schemas/EventLocationResource"
},
{
"type": "null"
}
]
},
"booking_limits": {
"type": "object",
"properties": {
"capacity": {
"type": [
"integer",
"null"
]
},
"allocation_total": {
"type": [
"integer",
"null"
]
},
"sellable": {
"type": [
"integer",
"null"
]
},
"allocations": {
"type": "array",
"items": {}
}
},
"required": [
"capacity",
"allocation_total",
"sellable",
"allocations"
]
},
"statistics": {
"type": "object",
"properties": {
"orders_created": {
"type": "integer"
},
"attendees_registered": {
"type": "integer"
},
"products_sold": {
"type": "integer"
},
"total_gross_sales": {
"type": "number"
},
"total_tax": {
"type": "number"
},
"total_fee": {
"type": "number"
},
"total_refunded": {
"type": "number"
}
},
"required": [
"orders_created",
"attendees_registered",
"products_sold"
]
},
"created_at": {
"type": [
"string",
"null"
]
},
"updated_at": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"event_id",
"short_id",
"start_date",
"end_date",
"status",
"capacity",
"used_capacity",
"available_capacity",
"label",
"show_available_capacity",
"is_overridden",
"is_past",
"is_future",
"is_active",
"created_at",
"updated_at"
],
"title": "EventOccurrenceResource"
},
"EventOccurrenceResourcePublic": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"event_id": {
"type": "integer"
},
"start_date": {
"type": "string"
},
"end_date": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string"
},
"capacity": {
"type": [
"integer",
"null"
]
},
"available_capacity": {
"type": [
"integer",
"null"
]
},
"label": {
"type": [
"string",
"null"
]
},
"is_past": {
"type": "boolean"
},
"is_future": {
"type": "boolean"
},
"is_active": {
"type": "boolean"
},
"event_location": {
"anyOf": [
{
"$ref": "#/components/schemas/EventLocationResourcePublic"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"event_id",
"start_date",
"end_date",
"status",
"label",
"is_past",
"is_future",
"is_active"
],
"title": "EventOccurrenceResourcePublic"
},
"EventResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"title": {
"type": "string"
},
"category": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"start_date": {
"type": [
"string",
"null"
]
},
"end_date": {
"type": [
"string",
"null"
]
},
"next_occurrence_start_date": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
],
"enum": [
"DRAFT",
"LIVE",
"ARCHIVED",
"PENDING_MANUAL_REVIEW",
null
]
},
"type": {
"type": "string",
"enum": [
"SINGLE",
"RECURRING"
]
},
"has_seat_map": {
"type": "boolean"
},
"recurrence_rule": {
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {}
},
{
"type": "string"
},
{
"type": "object"
}
]
},
"lifecycle_status": {
"type": "string",
"enum": [
"UPCOMING",
"ONGOING",
"ENDED"
]
},
"currency": {
"type": "string"
},
"timezone": {
"type": [
"string",
"null"
]
},
"slug": {
"type": "string"
},
"organizer_id": {
"type": [
"integer",
"null"
]
},
"products": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/ProductResource"
}
},
"product_categories": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/ProductCategoryResource"
}
},
"attributes": {
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {}
},
{
"type": "string"
},
{
"type": "object"
}
]
},
"images": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/ImageResource"
}
},
"event_location": {
"anyOf": [
{
"$ref": "#/components/schemas/EventLocationResource"
},
{
"type": "null"
}
]
},
"settings": {
"anyOf": [
{
"$ref": "#/components/schemas/EventSettingsResource"
},
{
"type": "null"
}
]
},
"organizer": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizerResource"
},
{
"type": "null"
}
]
},
"statistics": {
"anyOf": [
{
"$ref": "#/components/schemas/EventStatisticsResource"
},
{
"type": "null"
}
]
},
"occurrences": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/EventOccurrenceResource"
}
}
},
"required": [
"id",
"title",
"category",
"description",
"start_date",
"end_date",
"next_occurrence_start_date",
"status",
"type",
"has_seat_map",
"recurrence_rule",
"lifecycle_status",
"currency",
"timezone",
"slug",
"organizer_id"
],
"title": "EventResource"
},
"EventResourcePublic": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"title": {
"type": "string"
},
"category": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"description_preview": {
"type": "string"
},
"start_date": {
"type": [
"string",
"null"
]
},
"end_date": {
"type": [
"string",
"null"
]
},
"next_occurrence_start_date": {
"type": [
"string",
"null"
]
},
"upcoming_occurrences_sold_out": {
"type": "boolean"
},
"has_seat_map": {
"type": "boolean"
},
"products_sold_out": {
"type": [
"boolean",
"null"
]
},
"last_occurrence_date": {
"type": [
"string",
"null"
]
},
"occurrences_month": {
"type": [
"string",
"null"
]
},
"type": {
"type": "string",
"enum": [
"SINGLE",
"RECURRING"
]
},
"currency": {
"type": "string"
},
"slug": {
"type": "string"
},
"status": {
"type": [
"string",
"null"
],
"enum": [
"DRAFT",
"LIVE",
"ARCHIVED",
"PENDING_MANUAL_REVIEW",
null
]
},
"lifecycle_status": {
"type": "string",
"enum": [
"UPCOMING",
"ONGOING",
"ENDED"
]
},
"timezone": {
"type": [
"string",
"null"
]
},
"event_location": {
"anyOf": [
{
"$ref": "#/components/schemas/EventLocationResourcePublic"
},
{
"type": "null"
}
]
},
"product_categories": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/ProductCategoryResourcePublic"
}
},
"settings": {
"anyOf": [
{
"$ref": "#/components/schemas/EventSettingsResourcePublic"
},
{
"type": "null"
}
]
},
"questions": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/QuestionResource"
}
},
"attributes": {
"type": "array",
"items": {}
},
"images": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/ImageResource"
}
},
"organizer": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizerResourcePublic"
},
{
"type": "null"
}
]
},
"occurrences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventOccurrenceResourcePublic"
}
}
},
"required": [
"id",
"title",
"category",
"description",
"description_preview",
"start_date",
"end_date",
"next_occurrence_start_date",
"upcoming_occurrences_sold_out",
"has_seat_map",
"type",
"currency",
"slug",
"status",
"lifecycle_status",
"timezone"
],
"title": "EventResourcePublic"
},
"EventSeatMapResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"event_id": {
"type": "integer"
},
"version": {
"type": "integer"
},
"layout": {
"type": "object"
},
"source_seat_map": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
]
},
"is_update_available_from_source": {
"type": "boolean"
},
"prevent_orphan_seats": {
"type": "boolean"
},
"max_seats_per_order": {
"type": [
"integer",
"null"
]
},
"allow_seat_change": {
"type": "boolean"
},
"band_products": {
"type": "array",
"items": {}
}
},
"required": [
"id",
"event_id",
"version",
"layout",
"source_seat_map",
"is_update_available_from_source",
"prevent_orphan_seats",
"max_seats_per_order",
"allow_seat_change",
"band_products"
],
"title": "EventSeatMapResource"
},
"EventSeatMapResourcePublic": {
"type": "object",
"properties": {
"version": {
"type": "integer"
},
"layout": {
"type": "object"
},
"band_products": {
"type": "array",
"items": {}
},
"prevent_orphan_seats": {
"type": "boolean"
},
"max_seats_per_order": {
"type": [
"integer",
"null"
]
},
"allow_seat_change": {
"type": "boolean"
}
},
"required": [
"version",
"layout",
"band_products",
"prevent_orphan_seats",
"max_seats_per_order",
"allow_seat_change"
],
"title": "EventSeatMapResourcePublic"
},
"EventSettingsResource": {
"type": "object",
"properties": {
"pre_checkout_message": {
"type": [
"string",
"null"
]
},
"post_checkout_message": {
"type": [
"string",
"null"
]
},
"product_page_message": {
"type": [
"string",
"null"
]
},
"continue_button_text": {
"type": [
"string",
"null"
]
},
"get_tickets_button_text": {
"type": [
"string",
"null"
]
},
"required_attendee_details": {
"type": "boolean"
},
"attendee_details_collection_method": {
"type": "string"
},
"email_footer_message": {
"type": [
"string",
"null"
]
},
"support_email": {
"type": [
"string",
"null"
]
},
"order_timeout_in_minutes": {
"type": "integer"
},
"homepage_body_background_color": {
"type": [
"string",
"null"
]
},
"homepage_background_color": {
"type": [
"string",
"null"
]
},
"homepage_primary_color": {
"type": [
"string",
"null"
]
},
"homepage_primary_text_color": {
"type": [
"string",
"null"
]
},
"homepage_secondary_color": {
"type": [
"string",
"null"
]
},
"homepage_secondary_text_color": {
"type": [
"string",
"null"
]
},
"homepage_background_type": {
"type": "string"
},
"website_url": {
"type": [
"string",
"null"
]
},
"maps_url": {
"type": [
"string",
"null"
]
},
"seo_title": {
"type": [
"string",
"null"
]
},
"seo_description": {
"type": [
"string",
"null"
]
},
"seo_keywords": {
"type": [
"string",
"null"
]
},
"allow_search_engine_indexing": {
"type": "boolean"
},
"notify_organizer_of_new_orders": {
"type": "boolean"
},
"price_display_mode": {
"type": "string"
},
"ticket_design_settings": {
"description": "Ticket design settings",
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {}
},
{
"type": "string"
},
{
"type": "object"
}
]
},
"payment_providers": {
"description": "Payment settings",
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {}
},
{
"type": "string"
},
{
"type": "object"
}
]
},
"offline_payment_instructions": {
"type": [
"string",
"null"
]
},
"allow_orders_awaiting_offline_payment_to_check_in": {
"type": "boolean"
},
"offline_payment_reporting_enabled": {
"type": "boolean"
},
"offline_payment_order_reference_enabled": {
"type": "boolean"
},
"payment_links_enabled": {
"type": "boolean"
},
"payment_link_expiry_hours": {
"type": "integer"
},
"enable_invoicing": {
"type": "boolean",
"description": "Invoice settings"
},
"invoice_label": {
"type": [
"string",
"null"
]
},
"invoice_prefix": {
"type": [
"string",
"null"
]
},
"invoice_start_number": {
"type": "integer"
},
"require_billing_address": {
"type": "boolean"
},
"organization_name": {
"type": [
"string",
"null"
]
},
"organization_address": {
"type": [
"string",
"null"
]
},
"invoice_tax_details": {
"type": [
"string",
"null"
]
},
"invoice_notes": {
"type": [
"string",
"null"
]
},
"invoice_payment_terms_days": {
"type": [
"integer",
"null"
]
},
"show_marketing_opt_in": {
"type": "boolean",
"description": "Marketing settings"
},
"allow_copy_details_to_all_attendees": {
"type": "boolean",
"description": "Attendee detail copy control"
},
"pass_platform_fee_to_buyer": {
"type": "boolean",
"description": "Platform fee settings"
},
"homepage_theme_settings": {
"description": "Homepage theme settings",
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {}
},
{
"type": "string"
},
{
"type": "object"
}
]
},
"homepage_sections": {
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {}
},
{
"type": "string"
},
{
"type": "object"
}
]
},
"allow_attendee_self_edit": {
"type": "boolean",
"description": "Self-service settings"
},
"show_available_occurrence_capacity": {
"type": "boolean",
"description": "Occurrence display"
},
"hide_sold_out_occurrences": {
"type": "boolean"
},
"waitlist_auto_process": {
"type": "boolean",
"description": "Waitlist settings"
},
"waitlist_offer_timeout_minutes": {
"type": [
"integer",
"null"
]
}
},
"required": [
"pre_checkout_message",
"post_checkout_message",
"product_page_message",
"continue_button_text",
"get_tickets_button_text",
"required_attendee_details",
"attendee_details_collection_method",
"email_footer_message",
"support_email",
"order_timeout_in_minutes",
"homepage_body_background_color",
"homepage_background_color",
"homepage_primary_color",
"homepage_primary_text_color",
"homepage_secondary_color",
"homepage_secondary_text_color",
"homepage_background_type",
"website_url",
"maps_url",
"seo_title",
"seo_description",
"seo_keywords",
"allow_search_engine_indexing",
"notify_organizer_of_new_orders",
"price_display_mode",
"ticket_design_settings",
"payment_providers",
"offline_payment_instructions",
"allow_orders_awaiting_offline_payment_to_check_in",
"offline_payment_reporting_enabled",
"offline_payment_order_reference_enabled",
"payment_links_enabled",
"payment_link_expiry_hours",
"enable_invoicing",
"invoice_label",
"invoice_prefix",
"invoice_start_number",
"require_billing_address",
"organization_name",
"organization_address",
"invoice_tax_details",
"invoice_notes",
"invoice_payment_terms_days",
"show_marketing_opt_in",
"allow_copy_details_to_all_attendees",
"pass_platform_fee_to_buyer",
"homepage_theme_settings",
"homepage_sections",
"allow_attendee_self_edit",
"show_available_occurrence_capacity",
"hide_sold_out_occurrences",
"waitlist_auto_process",
"waitlist_offer_timeout_minutes"
],
"title": "EventSettingsResource"
},
"EventSettingsResourcePublic": {
"type": "object",
"properties": {
"pre_checkout_message": {
"type": [
"string",
"null"
]
},
"post_checkout_message": {
"type": [
"string",
"null"
]
},
"product_page_message": {
"type": [
"string",
"null"
]
},
"continue_button_text": {
"type": [
"string",
"null"
]
},
"get_tickets_button_text": {
"type": [
"string",
"null"
]
},
"required_attendee_details": {
"type": "boolean"
},
"attendee_details_collection_method": {
"type": "string"
},
"email_footer_message": {
"type": [
"string",
"null"
]
},
"support_email": {
"type": [
"string",
"null"
]
},
"order_timeout_in_minutes": {
"type": "integer"
},
"homepage_body_background_color": {
"type": [
"string",
"null"
],
"description": "Homepage settings"
},
"homepage_background_color": {
"type": [
"string",
"null"
]
},
"homepage_primary_color": {
"type": [
"string",
"null"
]
},
"homepage_primary_text_color": {
"type": [
"string",
"null"
]
},
"homepage_secondary_color": {
"type": [
"string",
"null"
]
},
"homepage_secondary_text_color": {
"type": [
"string",
"null"
]
},
"homepage_background_type": {
"type": "string"
},
"website_url": {
"type": [
"string",
"null"
]
},
"maps_url": {
"type": [
"string",
"null"
]
},
"ticket_design_settings": {
"description": "Ticket design settings",
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {}
},
{
"type": "string"
},
{
"type": "object"
}
]
},
"seo_title": {
"type": [
"string",
"null"
],
"description": "SEO settings"
},
"seo_description": {
"type": [
"string",
"null"
]
},
"seo_keywords": {
"type": [
"string",
"null"
]
},
"allow_search_engine_indexing": {
"type": "boolean"
},
"price_display_mode": {
"type": "string"
},
"payment_providers": {
"description": "Payment settings",
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {}
},
{
"type": "string"
},
{
"type": "object"
}
]
},
"offline_payment_instructions": {
"type": [
"string",
"null"
]
},
"allow_orders_awaiting_offline_payment_to_check_in": {
"type": "boolean"
},
"offline_payment_reporting_enabled": {
"type": "boolean"
},
"offline_payment_order_reference_enabled": {
"type": "boolean"
},
"payment_links_enabled": {
"type": "boolean"
},
"payment_link_expiry_hours": {
"type": "integer"
},
"require_billing_address": {
"type": "boolean",
"description": "Invoice settings"
},
"invoice_label": {
"type": [
"string",
"null"
]
},
"show_marketing_opt_in": {
"type": "boolean",
"description": "Marketing settings"
},
"allow_copy_details_to_all_attendees": {
"type": "boolean",
"description": "Attendee detail copy control"
},
"pass_platform_fee_to_buyer": {
"type": "boolean",
"description": "Platform fee settings"
},
"homepage_theme_settings": {
"description": "Homepage theme settings",
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {}
},
{
"type": "string"
},
{
"type": "object"
}
]
},
"homepage_sections": {
"anyOf": [
{
"type": "array",
"items": {}
},
{
"type": "null"
},
{
"type": "string"
},
{
"type": "object"
}
]
},
"allow_attendee_self_edit": {
"type": "boolean",
"description": "Self-service settings"
},
"show_available_occurrence_capacity": {
"type": "boolean",
"description": "Occurrence display"
},
"hide_sold_out_occurrences": {
"type": "boolean"
},
"waitlist_auto_process": {
"type": "boolean",
"description": "Waitlist settings"
},
"waitlist_offer_timeout_minutes": {
"type": [
"integer",
"null"
]
}
},
"required": [
"pre_checkout_message",
"product_page_message",
"continue_button_text",
"get_tickets_button_text",
"required_attendee_details",
"attendee_details_collection_method",
"email_footer_message",
"support_email",
"order_timeout_in_minutes",
"homepage_body_background_color",
"homepage_background_color",
"homepage_primary_color",
"homepage_primary_text_color",
"homepage_secondary_color",
"homepage_secondary_text_color",
"homepage_background_type",
"website_url",
"maps_url",
"ticket_design_settings",
"seo_title",
"seo_description",
"seo_keywords",
"allow_search_engine_indexing",
"price_display_mode",
"payment_providers",
"offline_payment_instructions",
"allow_orders_awaiting_offline_payment_to_check_in",
"offline_payment_reporting_enabled",
"offline_payment_order_reference_enabled",
"payment_links_enabled",
"payment_link_expiry_hours",
"require_billing_address",
"invoice_label",
"show_marketing_opt_in",
"allow_copy_details_to_all_attendees",
"pass_platform_fee_to_buyer",
"homepage_theme_settings",
"homepage_sections",
"allow_attendee_self_edit",
"show_available_occurrence_capacity",
"hide_sold_out_occurrences",
"waitlist_auto_process",
"waitlist_offer_timeout_minutes"
],
"title": "EventSettingsResourcePublic"
},
"EventSpaceResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"event_location_id": {
"type": [
"integer",
"null"
]
},
"venue": {
"anyOf": [
{
"$ref": "#/components/schemas/LocationPublicResource"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"event_location_id",
"venue"
],
"title": "EventSpaceResource"
},
"EventSpaceResourcePublic": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"venue": {
"anyOf": [
{
"$ref": "#/components/schemas/LocationPublicResource"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"venue"
],
"title": "EventSpaceResourcePublic"
},
"EventStatisticsResource": {
"type": "object",
"properties": {
"unique_views": {
"type": "integer"
},
"total_views": {
"type": "integer"
},
"products_sold": {
"type": "integer"
},
"attendees_registered": {
"type": "integer"
},
"sales_total_gross": {
"type": "number"
},
"total_tax": {
"type": "number"
},
"sales_total_before_additions": {
"type": "number"
},
"total_fee": {
"type": "number"
},
"total_refunded": {
"type": "number"
}
},
"required": [
"unique_views",
"total_views",
"products_sold",
"attendees_registered"
],
"title": "EventStatisticsResource"
},
"ExportProductPurchasesRequest": {
"type": "object",
"properties": {
"product_id": {
"type": [
"integer",
"null"
]
},
"event_occurrence_id": {
"type": [
"integer",
"null"
]
},
"statuses": {
"type": [
"array",
"null"
],
"items": {
"type": "string",
"enum": [
"SOLD",
"AWAITING_PAYMENT",
"CANCELLED"
]
},
"maxItems": 3
},
"refund_statuses": {
"type": [
"array",
"null"
],
"items": {
"type": "string",
"enum": [
"REFUND_PENDING",
"REFUND_FAILED",
"REFUNDED",
"PARTIALLY_REFUNDED"
]
},
"maxItems": 4
},
"query": {
"type": [
"string",
"null"
],
"maxLength": 255
}
},
"title": "ExportProductPurchasesRequest"
},
"GenerateOccurrencesRequest": {
"type": "object",
"properties": {
"recurrence_rule": {
"type": "object",
"properties": {
"frequency": {
"type": "string",
"enum": [
"daily",
"weekly",
"monthly",
"yearly"
]
},
"interval": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"range": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"count",
"until"
]
},
"count": {
"type": "integer",
"minimum": 1,
"maximum": 1200
},
"until": {
"type": "string",
"format": "date-time"
},
"start": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"type"
]
},
"days_of_week": {
"type": "array",
"items": {
"type": "string",
"enum": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
]
}
},
"times_of_day": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"label": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"duration_minutes": {
"type": [
"integer",
"null"
],
"minimum": 1,
"maximum": 10080
}
}
},
"maxItems": 24
},
"duration_minutes": {
"type": [
"integer",
"null"
],
"minimum": 1,
"maximum": 10080
},
"default_capacity": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"excluded_dates": {
"type": [
"array",
"null"
],
"items": {
"type": "string",
"format": "date-time"
},
"maxItems": 1200
},
"excluded_occurrences": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"maxItems": 1200
},
"additional_dates": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time"
},
"time": {
"type": [
"string",
"null"
]
}
},
"required": [
"date"
]
},
"maxItems": 1200
},
"monthly_pattern": {
"type": [
"string",
"null"
],
"enum": [
"by_day_of_month",
"by_day_of_week",
null
]
},
"days_of_month": {
"type": [
"array",
"null"
],
"items": {
"type": "integer",
"minimum": 1,
"maximum": 31
}
},
"day_of_week": {
"type": [
"string",
"null"
],
"enum": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday",
null
]
},
"week_position": {
"type": [
"integer",
"null"
],
"enum": [
-1,
1,
2,
3,
4,
null
]
},
"month": {
"type": [
"integer",
"null"
],
"minimum": 1,
"maximum": 12
}
},
"required": [
"frequency",
"range"
]
}
},
"required": [
"recurrence_rule"
],
"title": "GenerateOccurrencesRequest"
},
"GeoPlaceResource": {
"type": "object",
"properties": {
"provider": {
"type": "string"
},
"provider_place_id": {
"type": "string"
},
"address": {
"type": "object",
"additionalProperties": {}
},
"latitude": {
"type": [
"number",
"null"
]
},
"longitude": {
"type": [
"number",
"null"
]
},
"display_name": {
"type": [
"string",
"null"
]
}
},
"required": [
"provider",
"provider_place_id",
"address",
"latitude",
"longitude",
"display_name"
],
"title": "GeoPlaceResource"
},
"GeoSuggestionResource": {
"type": "object",
"properties": {
"provider_place_id": {
"type": "string"
},
"primary_text": {
"type": "string"
},
"secondary_text": {
"type": [
"string",
"null"
]
}
},
"required": [
"provider_place_id",
"primary_text",
"secondary_text"
],
"title": "GeoSuggestionResource"
},
"ImageResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"url": {
"type": "string"
},
"path": {
"type": [
"string",
"null"
]
},
"size": {
"type": [
"integer",
"null"
]
},
"file_name": {
"type": [
"string",
"null"
]
},
"mime_type": {
"type": [
"string",
"null"
]
},
"type": {
"type": [
"string",
"null"
]
},
"width": {
"type": [
"integer",
"null"
]
},
"height": {
"type": [
"integer",
"null"
]
},
"avg_colour": {
"type": [
"string",
"null"
]
},
"lqip_base64": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"url",
"path",
"size",
"file_name",
"mime_type",
"type",
"width",
"height",
"avg_colour",
"lqip_base64"
],
"title": "ImageResource"
},
"ImportLineupRequest": {
"type": "object",
"properties": {
"people": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 255
},
"tagline": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"bio": {
"type": [
"string",
"null"
],
"maxLength": 20000
},
"links": {
"type": "array",
"items": {
"type": "string",
"format": "uri",
"maxLength": 500
},
"maxItems": 12
},
"billing_tier": {
"anyOf": [
{
"$ref": "#/components/schemas/LineupBillingTier"
},
{
"type": "null"
}
]
},
"role_label": {
"type": [
"string",
"null"
],
"maxLength": 100
},
"is_hidden": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"name"
]
},
"maxItems": 500
},
"slots": {
"type": "array",
"items": {
"type": "object",
"properties": {
"starts_at": {
"type": "string",
"format": "date-time"
},
"ends_at": {
"type": "string",
"format": "date-time"
},
"stage": {
"type": [
"string",
"null"
],
"maxLength": 100
},
"title": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"description": {
"type": [
"string",
"null"
],
"maxLength": 20000
},
"people": {
"type": "array",
"items": {
"type": "string",
"maxLength": 255
},
"maxItems": 50
}
},
"required": [
"starts_at",
"ends_at"
]
},
"maxItems": 1000
}
},
"required": [
"people",
"slots"
],
"title": "ImportLineupRequest"
},
"JsonResource": {
"type": "string",
"title": "JsonResource"
},
"LineupBillingTier": {
"type": "string",
"enum": [
"HEADLINER",
"FEATURED",
"STANDARD"
],
"title": "LineupBillingTier"
},
"LineupEntryResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"profile_id": {
"type": "integer"
},
"billing_tier": {
"type": "string",
"enum": [
"HEADLINER",
"FEATURED",
"STANDARD"
]
},
"role_label": {
"type": [
"string",
"null"
]
},
"is_hidden": {
"type": "boolean"
},
"sort_order": {
"type": "integer"
},
"profile": {
"anyOf": [
{
"$ref": "#/components/schemas/ProfileResource"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"profile_id",
"billing_tier",
"role_label",
"is_hidden",
"sort_order",
"profile"
],
"title": "LineupEntryResource"
},
"LineupEntryResourcePublic": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"billing_tier": {
"type": "string",
"enum": [
"HEADLINER",
"FEATURED",
"STANDARD"
]
},
"role_label": {
"type": [
"string",
"null"
]
},
"profile": {
"anyOf": [
{
"$ref": "#/components/schemas/ProfileResourcePublic"
},
{
"type": "null"
}
]
},
"schedule_days": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"id",
"billing_tier",
"role_label",
"profile"
],
"title": "LineupEntryResourcePublic"
},
"LocationPublicResource": {
"type": "object",
"properties": {
"name": {
"type": [
"string",
"null"
]
},
"structured_address": {
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {}
},
{
"type": "string"
},
{
"type": "object"
}
]
},
"latitude": {
"type": [
"number",
"null"
]
},
"longitude": {
"type": [
"number",
"null"
]
}
},
"required": [
"name",
"structured_address",
"latitude",
"longitude"
],
"title": "LocationPublicResource"
},
"LocationResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"organizer_id": {
"type": "integer"
},
"name": {
"type": [
"string",
"null"
]
},
"structured_address": {
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {}
},
{
"type": "string"
},
{
"type": "object"
}
]
},
"latitude": {
"type": [
"number",
"null"
]
},
"longitude": {
"type": [
"number",
"null"
]
},
"provider": {
"type": [
"string",
"null"
]
},
"provider_place_id": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": [
"string",
"null"
]
},
"updated_at": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"organizer_id",
"name",
"structured_address",
"latitude",
"longitude",
"provider",
"provider_place_id",
"created_at",
"updated_at"
],
"title": "LocationResource"
},
"MeResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"timezone": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": [
"string",
"null"
]
},
"full_name": {
"type": "string"
},
"email": {
"type": "string"
},
"is_email_verified": {
"type": "boolean"
},
"locale": {
"type": "string"
},
"two_factor_enabled": {
"type": "boolean"
},
"has_pending_email_change": {
"type": "boolean"
},
"has_password": {
"type": "boolean"
},
"marketing_opted_in_at": {
"type": [
"string",
"null"
]
},
"is_impersonating": {
"type": "boolean"
},
"impersonator_id": {
"type": "string"
},
"enforce_email_confirmation_during_registration": {
"type": "boolean"
},
"role": {
"type": [
"string",
"null"
]
},
"is_account_owner": {
"type": [
"boolean",
"null"
]
},
"last_login_at": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
},
"account_id": {
"type": [
"integer",
"null"
]
},
"notify_new_orders": {
"type": [
"boolean",
"null"
]
},
"sso_sign_in": {
"type": [
"string",
"null"
],
"enum": [
"SSO",
"EXEMPT",
"PASSWORD",
null
]
},
"access": {
"type": "object",
"properties": {
"scope": {
"type": "string",
"enum": [
"ACCOUNT",
"RESTRICTED"
]
},
"organizer_ids": {
"type": "array",
"items": {
"type": "integer"
}
},
"event_ids": {
"type": "array",
"items": {
"type": "integer"
}
},
"permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"EDIT",
"VIEW_FINANCIALS",
"ISSUE_REFUNDS",
"MANAGE_PAYMENTS",
"DELETE_EVENTS",
"MANAGE_TEAM",
"MANAGE_ACCOUNT"
]
}
}
},
"required": [
"scope",
"organizer_ids",
"event_ids",
"permissions"
]
},
"pending_email": {
"type": [
"string",
"null"
]
},
"two_factor_setup_required": {
"type": "string"
},
"password_reset_allowed": {
"type": "boolean"
},
"feature_flags": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
},
"licence": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"ACTIVE",
"GRACE",
"LAPSED",
"NONE",
"DEV"
]
},
"expires_at": {
"type": [
"string",
"null"
]
},
"grace_ends_at": {
"type": [
"string",
"null"
]
},
"invalid_reason": {
"type": "string"
},
"features": {
"type": "array",
"items": {
"type": "string",
"enum": [
"seating",
"box_office",
"enterprise_sso",
"white_label"
]
}
},
"unlocked_features": {
"type": "array",
"items": {
"type": "string",
"enum": [
"seating",
"box_office",
"enterprise_sso",
"white_label"
]
}
},
"features_in_use": {
"type": "array",
"items": {
"type": "string",
"enum": [
"seating",
"box_office",
"enterprise_sso",
"white_label"
]
}
}
},
"required": [
"status",
"expires_at",
"grace_ends_at",
"invalid_reason",
"features",
"unlocked_features",
"features_in_use"
]
}
},
"required": [
"id",
"timezone",
"first_name",
"last_name",
"full_name",
"email",
"is_email_verified",
"locale",
"two_factor_enabled",
"two_factor_setup_required",
"password_reset_allowed",
"feature_flags",
"licence"
],
"title": "MeResource"
},
"MessageResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"event_id": {
"type": "integer"
},
"subject": {
"type": "string"
},
"message": {
"type": "string"
},
"type": {
"type": "string"
},
"attendee_ids": {
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {}
},
{
"type": "string"
},
{
"type": "object"
}
]
},
"order_id": {
"type": [
"integer",
"null"
]
},
"product_ids": {
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {}
},
{
"type": "string"
},
{
"type": "object"
}
]
},
"sent_at": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string"
},
"scheduled_at": {
"type": [
"string",
"null"
]
},
"message_preview": {
"type": "string"
},
"sent_by_user": {
"anyOf": [
{
"$ref": "#/components/schemas/UserResource"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"event_id",
"subject",
"message",
"type",
"attendee_ids",
"order_id",
"product_ids",
"sent_at",
"status",
"scheduled_at",
"message_preview"
],
"title": "MessageResource"
},
"MoveAttendeeSeatRequest": {
"type": "object",
"properties": {
"seat_uid": {
"type": "string",
"maxLength": 24
}
},
"required": [
"seat_uid"
],
"title": "MoveAttendeeSeatRequest"
},
"OccupiedSeatResource": {
"type": "object",
"properties": {
"seat_uid": {
"type": "string"
},
"seat_label": {
"type": "string"
},
"is_zone": {
"type": "boolean"
},
"band_key": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"HELD",
"SOLD",
"BLOCKED"
]
},
"block_reason": {
"type": [
"string",
"null"
]
},
"attendee_public_id": {
"type": [
"string",
"null"
]
},
"attendee_name": {
"type": [
"string",
"null"
]
}
},
"required": [
"seat_uid",
"seat_label",
"is_zone",
"band_key",
"status",
"block_reason",
"attendee_public_id",
"attendee_name"
],
"title": "OccupiedSeatResource"
},
"OccurrenceProductAvailabilityResource": {
"type": "object",
"properties": {
"product_id": {
"type": "integer"
},
"product_price_id": {
"type": "integer"
},
"quantity_sold": {
"type": "integer"
},
"quantity_available": {
"type": [
"integer",
"null"
]
}
},
"required": [
"product_id",
"product_price_id",
"quantity_sold",
"quantity_available"
],
"title": "OccurrenceProductAvailabilityResource"
},
"OfferWaitlistEntryRequest": {
"type": "object",
"properties": {
"product_price_id": {
"type": "integer"
},
"entry_id": {
"type": "integer"
},
"quantity": {
"type": "integer",
"minimum": 1,
"maximum": 50
},
"event_occurrence_id": {
"type": [
"integer",
"null"
]
}
},
"title": "OfferWaitlistEntryRequest"
},
"OrderItemResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"order_id": {
"type": "integer"
},
"total_before_additions": {
"type": "number"
},
"price": {
"type": "number"
},
"price_before_discount": {
"type": [
"number",
"null"
]
},
"taxes_and_fees_rollup": {
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {}
},
{
"type": "string"
},
{
"type": "object"
}
]
},
"quantity": {
"type": "integer"
},
"product_id": {
"type": "integer"
},
"event_occurrence_id": {
"type": [
"integer",
"null"
]
},
"band_key": {
"type": [
"string",
"null"
]
},
"item_name": {
"type": [
"string",
"null"
]
},
"event_occurrence": {
"anyOf": [
{
"$ref": "#/components/schemas/EventOccurrenceResource"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"order_id",
"quantity",
"product_id",
"event_occurrence_id",
"band_key",
"item_name"
],
"title": "OrderItemResource"
},
"OrderItemResourcePublic": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"order_id": {
"type": "integer"
},
"total_before_additions": {
"type": "number"
},
"total_before_discount": {
"type": "number"
},
"price": {
"type": "number"
},
"price_before_discount": {
"type": [
"number",
"null"
]
},
"quantity": {
"type": "integer"
},
"product_id": {
"type": "integer"
},
"product_price_id": {
"type": "integer"
},
"item_name": {
"type": [
"string",
"null"
]
},
"total_service_fee": {
"type": [
"number",
"null"
]
},
"total_tax": {
"type": "number"
},
"total_gross": {
"type": [
"number",
"null"
]
},
"taxes_and_fees_rollup": {
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {}
},
{
"type": "string"
},
{
"type": "object"
}
]
},
"event_occurrence_id": {
"type": [
"integer",
"null"
]
},
"event_occurrence": {
"anyOf": [
{
"$ref": "#/components/schemas/EventOccurrenceResourcePublic"
},
{
"type": "null"
}
]
},
"product": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductResourcePublic"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"order_id",
"total_before_additions",
"total_before_discount",
"price",
"price_before_discount",
"quantity",
"product_id",
"product_price_id",
"item_name",
"total_service_fee",
"total_tax",
"total_gross",
"taxes_and_fees_rollup",
"event_occurrence_id"
],
"title": "OrderItemResourcePublic"
},
"OrderResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"short_id": {
"type": "string"
},
"total_before_additions": {
"type": "number"
},
"total_gross": {
"type": "number"
},
"total_tax": {
"type": "number"
},
"total_fee": {
"type": "number"
},
"total_refunded": {
"type": "number"
},
"taxes_and_fees_rollup": {
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {}
},
{
"type": "string"
},
{
"type": "object"
}
]
},
"status": {
"type": "string",
"enum": [
"RESERVED",
"CANCELLED",
"COMPLETED",
"AWAITING_OFFLINE_PAYMENT",
"ABANDONED"
]
},
"refund_status": {
"type": [
"string",
"null"
],
"enum": [
"REFUND_PENDING",
"REFUND_FAILED",
"REFUNDED",
"PARTIALLY_REFUNDED",
null
]
},
"payment_status": {
"type": [
"string",
"null"
],
"enum": [
"NO_PAYMENT_REQUIRED",
"AWAITING_PAYMENT",
"AWAITING_OFFLINE_PAYMENT",
"PAYMENT_FAILED",
"PAYMENT_RECEIVED",
null
]
},
"currency": {
"type": "string"
},
"first_name": {
"type": [
"string",
"null"
]
},
"last_name": {
"type": [
"string",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": "string"
},
"public_id": {
"type": "string"
},
"is_partially_refunded": {
"type": "boolean"
},
"is_fully_refunded": {
"type": "boolean"
},
"is_free_order": {
"type": "boolean"
},
"is_manually_created": {
"type": "boolean"
},
"box_office_id": {
"type": [
"integer",
"null"
]
},
"box_office_operator_name": {
"type": [
"string",
"null"
]
},
"box_office_tender": {
"type": [
"string",
"null"
],
"enum": [
"CASH",
"CARD",
"COMP",
"OTHER",
"FREE",
null
]
},
"box_office_amount_tendered": {
"type": [
"number",
"null"
]
},
"box_office_change_due": {
"type": [
"number",
"null"
]
},
"box_office_reference": {
"type": [
"string",
"null"
]
},
"address": {
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {}
},
{
"type": "string"
},
{
"type": "object"
}
]
},
"notes": {
"type": [
"string",
"null"
]
},
"payment_provider": {
"type": [
"string",
"null"
]
},
"payment_link_created_at": {
"type": [
"string",
"null"
]
},
"offline_payment_reported_at": {
"type": [
"string",
"null"
]
},
"offline_payment_note": {
"type": [
"string",
"null"
]
},
"promo_code": {
"type": [
"string",
"null"
]
},
"event_id": {
"type": "integer"
},
"order_items": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/OrderItemResource"
}
},
"attendees": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/AttendeeResource"
}
},
"question_answers": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/QuestionAnswerViewResource"
}
},
"latest_invoice": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"invoice_number": {
"type": "string"
},
"order_id": {
"type": "integer"
},
"status": {
"type": "string"
}
},
"required": [
"id",
"invoice_number",
"order_id",
"status"
]
}
},
"required": [
"id",
"status",
"refund_status",
"payment_status",
"currency",
"first_name",
"last_name",
"email",
"created_at",
"public_id",
"is_partially_refunded",
"is_fully_refunded",
"is_free_order",
"is_manually_created",
"box_office_id",
"address",
"notes",
"payment_provider",
"payment_link_created_at",
"offline_payment_reported_at",
"offline_payment_note",
"promo_code",
"event_id"
],
"title": "OrderResource"
},
"OrderResourcePublic": {
"type": "object",
"properties": {
"short_id": {
"type": "string"
},
"total_before_additions": {
"type": "number"
},
"total_tax": {
"type": "number"
},
"total_gross": {
"type": "number"
},
"total_fee": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"RESERVED",
"CANCELLED",
"COMPLETED",
"AWAITING_OFFLINE_PAYMENT",
"ABANDONED"
]
},
"refund_status": {
"type": [
"string",
"null"
],
"enum": [
"REFUND_PENDING",
"REFUND_FAILED",
"REFUNDED",
"PARTIALLY_REFUNDED",
null
]
},
"payment_status": {
"type": [
"string",
"null"
],
"enum": [
"NO_PAYMENT_REQUIRED",
"AWAITING_PAYMENT",
"AWAITING_OFFLINE_PAYMENT",
"PAYMENT_FAILED",
"PAYMENT_RECEIVED",
null
]
},
"currency": {
"type": "string"
},
"reserved_until": {
"type": [
"string",
"null"
]
},
"is_expired": {
"type": "boolean"
},
"first_name": {
"type": [
"string",
"null"
]
},
"last_name": {
"type": [
"string",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
},
"public_id": {
"type": "string"
},
"is_payment_required": {
"type": "boolean"
},
"payment_link_created_at": {
"type": [
"string",
"null"
]
},
"is_payment_link_payer": {
"type": "boolean"
},
"offline_payment_reported_at": {
"type": [
"string",
"null"
]
},
"payment_link_url": {
"type": [
"string",
"null"
]
},
"promo_code": {
"type": [
"string",
"null"
]
},
"taxes_and_fees_rollup": {
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {}
},
{
"type": "string"
},
{
"type": "object"
}
]
},
"event": {
"anyOf": [
{
"$ref": "#/components/schemas/EventResourcePublic"
},
{
"type": "null"
}
]
},
"latest_invoice": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"invoice_number": {
"type": "string"
},
"order_id": {
"type": "integer"
},
"status": {
"type": "string"
}
},
"required": [
"id",
"invoice_number",
"order_id",
"status"
]
},
"address": {
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {}
},
{
"type": "string"
},
{
"type": "object"
}
]
},
"order_items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderItemResourcePublic"
}
},
"attendees": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AttendeeResourcePublic"
}
},
"seats": {
"type": "array",
"items": {
"type": "object",
"properties": {
"seat_uid": {
"type": "string"
},
"seat_label": {
"type": "string"
},
"order_item_id": {
"type": [
"integer",
"null"
]
}
},
"required": [
"seat_uid",
"seat_label",
"order_item_id"
]
}
},
"session_identifier": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": "string"
},
"box_office_operator_name": {
"type": [
"string",
"null"
]
},
"box_office_tender": {
"type": [
"string",
"null"
],
"enum": [
"CASH",
"CARD",
"COMP",
"OTHER",
"FREE",
null
]
},
"box_office_amount_tendered": {
"type": [
"number",
"null"
]
},
"box_office_change_due": {
"type": [
"number",
"null"
]
},
"box_office_reference": {
"type": [
"string",
"null"
]
},
"box_office_card_error": {
"type": [
"object",
"null"
],
"properties": {
"code": {
"type": [
"string",
"null"
]
},
"message": {
"type": [
"string",
"null"
]
},
"charge_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"code",
"message",
"charge_id"
]
}
},
"required": [
"short_id",
"total_before_additions",
"total_tax",
"total_gross",
"total_fee",
"status",
"refund_status",
"payment_status",
"currency",
"reserved_until",
"first_name",
"last_name",
"email",
"public_id",
"is_payment_required",
"payment_link_created_at",
"is_payment_link_payer",
"offline_payment_reported_at",
"promo_code",
"taxes_and_fees_rollup"
],
"title": "OrderResourcePublic"
},
"OrganizerConfigurationResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"is_system_default": {
"type": "boolean"
},
"default_for_currency": {
"type": [
"string",
"null"
]
},
"application_fees": {
"type": "object",
"properties": {
"percentage": {
"type": "number"
},
"fixed": {
"type": "number"
},
"currency": {
"type": "string"
}
},
"required": [
"percentage",
"fixed",
"currency"
]
},
"bypass_application_fees": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"is_system_default",
"default_for_currency",
"application_fees",
"bypass_application_fees"
],
"title": "OrganizerConfigurationResource"
},
"OrganizerResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"phone": {
"type": [
"string",
"null"
]
},
"website": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"timezone": {
"type": "string"
},
"currency": {
"type": "string"
},
"slug": {
"type": "string"
},
"status": {
"type": "string"
},
"location_id": {
"type": [
"integer",
"null"
]
},
"location": {
"anyOf": [
{
"$ref": "#/components/schemas/LocationResource"
},
{
"type": "null"
}
]
},
"images": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/ImageResource"
}
},
"settings": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizerSettingsPublicResource"
},
{
"type": "null"
}
]
},
"stripe_connect_setup_complete": {
"type": "boolean"
},
"stripe_account_id": {
"type": [
"string",
"null"
]
},
"configuration": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizerConfigurationResource"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"email",
"phone",
"website",
"description",
"timezone",
"currency",
"slug",
"status",
"location_id"
],
"title": "OrganizerResource"
},
"OrganizerResourcePublic": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"website": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"slug": {
"type": "string"
},
"status": {
"type": "string"
},
"location": {
"anyOf": [
{
"$ref": "#/components/schemas/LocationPublicResource"
},
{
"type": "null"
}
]
},
"images": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/ImageResource"
}
},
"events": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/EventResourcePublic"
}
},
"settings": {
"anyOf": [
{
"$ref": "#/components/schemas/OrganizerSettingsPublicResource"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"website",
"description",
"slug",
"status"
],
"title": "OrganizerResourcePublic"
},
"OrganizerSettingsPublicResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"organizer_id": {
"type": "integer"
},
"default_attendee_details_collection_method": {
"type": "string"
},
"default_show_marketing_opt_in": {
"type": "boolean"
},
"default_pass_platform_fee_to_buyer": {
"type": "boolean"
},
"default_allow_attendee_self_edit": {
"type": "boolean"
},
"social_media_handles": {
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {}
},
{
"type": "string"
},
{
"type": "object"
}
]
},
"homepage_theme_settings": {
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {}
},
{
"type": "string"
},
{
"type": "object"
}
]
},
"homepage_sections": {
"anyOf": [
{
"type": "array",
"items": {}
},
{
"type": "null"
},
{
"type": "string"
},
{
"type": "object"
}
]
},
"homepage_visibility": {
"type": "string"
},
"website_url": {
"type": [
"string",
"null"
]
},
"seo_keywords": {
"type": [
"string",
"null"
]
},
"seo_title": {
"type": [
"string",
"null"
]
},
"seo_description": {
"type": [
"string",
"null"
]
},
"allow_search_engine_indexing": {
"type": "boolean"
},
"tracking_pixels": {
"type": "array",
"items": {}
},
"first_day_of_week": {
"type": "integer"
}
},
"required": [
"id",
"organizer_id",
"default_attendee_details_collection_method",
"default_show_marketing_opt_in",
"default_pass_platform_fee_to_buyer",
"default_allow_attendee_self_edit",
"social_media_handles",
"homepage_theme_settings",
"homepage_sections",
"homepage_visibility",
"website_url",
"seo_keywords",
"seo_title",
"seo_description",
"allow_search_engine_indexing",
"tracking_pixels",
"first_day_of_week"
],
"title": "OrganizerSettingsPublicResource"
},
"OrganizerSettingsResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"organizer_id": {
"type": "integer"
},
"default_attendee_details_collection_method": {
"type": "string"
},
"default_show_marketing_opt_in": {
"type": "boolean"
},
"default_pass_platform_fee_to_buyer": {
"type": "boolean"
},
"default_allow_attendee_self_edit": {
"type": "boolean"
},
"social_media_handles": {
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {}
},
{
"type": "string"
},
{
"type": "object"
}
]
},
"homepage_theme_settings": {
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {}
},
{
"type": "string"
},
{
"type": "object"
}
]
},
"homepage_sections": {
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {}
},
{
"type": "string"
},
{
"type": "object"
}
]
},
"homepage_visibility": {
"type": "string"
},
"homepage_password": {
"type": [
"string",
"null"
]
},
"website_url": {
"type": [
"string",
"null"
]
},
"seo_keywords": {
"type": [
"string",
"null"
]
},
"seo_title": {
"type": [
"string",
"null"
]
},
"seo_description": {
"type": [
"string",
"null"
]
},
"allow_search_engine_indexing": {
"type": "boolean"
},
"tracking_pixels": {
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {}
},
{
"type": "string"
},
{
"type": "object"
}
]
},
"tracking_consent_acknowledged": {
"type": "boolean"
},
"first_day_of_week": {
"type": "integer"
}
},
"required": [
"id",
"organizer_id",
"default_attendee_details_collection_method",
"default_show_marketing_opt_in",
"default_pass_platform_fee_to_buyer",
"default_allow_attendee_self_edit",
"social_media_handles",
"homepage_theme_settings",
"homepage_sections",
"homepage_visibility",
"homepage_password",
"website_url",
"seo_keywords",
"seo_title",
"seo_description",
"allow_search_engine_indexing",
"tracking_pixels",
"tracking_consent_acknowledged",
"first_day_of_week"
],
"title": "OrganizerSettingsResource"
},
"OrganizerStatsResponseDTO": {
"type": "object",
"properties": {
"total_products_sold": {
"type": "integer"
},
"total_attendees_registered": {
"type": "integer"
},
"total_orders": {
"type": "integer"
},
"total_gross_sales": {
"type": "number"
},
"total_fees": {
"type": "number"
},
"total_tax": {
"type": "number"
},
"total_views": {
"type": "number"
},
"total_refunded": {
"type": "number"
},
"currency_code": {
"type": "string"
},
"daily_stats": {
"type": "object"
},
"start_date": {
"type": "string"
},
"end_date": {
"type": "string"
},
"all_organizers_currencies": {
"type": "array",
"items": {}
}
},
"required": [
"total_products_sold",
"total_attendees_registered",
"total_orders",
"total_gross_sales",
"total_fees",
"total_tax",
"total_views",
"total_refunded",
"currency_code",
"daily_stats",
"start_date",
"end_date",
"all_organizers_currencies"
],
"title": "OrganizerStatsResponseDTO"
},
"OrganizerVatSettingResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"organizer_id": {
"type": "integer"
},
"vat_registered": {
"type": "boolean"
},
"vat_number": {
"type": [
"string",
"null"
]
},
"vat_validated": {
"type": "boolean"
},
"vat_validation_status": {
"type": "string"
},
"vat_validation_error": {
"type": [
"string",
"null"
]
},
"vat_validation_attempts": {
"type": "integer"
},
"vat_validation_date": {
"type": [
"string",
"null"
]
},
"business_name": {
"type": [
"string",
"null"
]
},
"business_address": {
"type": [
"string",
"null"
]
},
"vat_country_code": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": [
"string",
"null"
]
},
"updated_at": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"organizer_id",
"vat_registered",
"vat_number",
"vat_validated",
"vat_validation_status",
"vat_validation_error",
"vat_validation_attempts",
"vat_validation_date",
"business_name",
"business_address",
"vat_country_code",
"created_at",
"updated_at"
],
"title": "OrganizerVatSettingResource"
},
"OutgoingMessageResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"message_id": {
"type": "integer"
},
"recipient": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"SENT",
"FAILED"
]
},
"delivered_at": {
"type": [
"string",
"null"
]
},
"bounced_at": {
"type": [
"string",
"null"
]
},
"complained_at": {
"type": [
"string",
"null"
]
},
"subject": {
"type": "string"
},
"created_at": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"message_id",
"recipient",
"status",
"delivered_at",
"bounced_at",
"complained_at",
"subject",
"created_at"
],
"title": "OutgoingMessageResource"
},
"PaginatedReportDTO": {
"type": "object",
"properties": {
"data": {
"type": "object",
"additionalProperties": {}
},
"pagination": {
"type": "object",
"properties": {
"total": {
"type": "integer"
},
"page": {
"type": "integer"
},
"per_page": {
"type": "integer"
},
"last_page": {
"type": "integer"
}
},
"required": [
"total",
"page",
"per_page",
"last_page"
]
}
},
"required": [
"data",
"pagination"
],
"title": "PaginatedReportDTO"
},
"PartialEditAttendeeRequest": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"first_name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"last_name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"email": {
"type": "string",
"format": "email",
"maxLength": 100
}
},
"title": "PartialEditAttendeeRequest"
},
"PartialUpdateOrganizerSettingsRequest": {
"type": "object",
"properties": {
"default_attendee_details_collection_method": {
"type": [
"string",
"null"
],
"description": "Event defaults",
"enum": [
"PER_TICKET",
"PER_ORDER",
null
]
},
"default_show_marketing_opt_in": {
"type": [
"boolean",
"null"
]
},
"default_pass_platform_fee_to_buyer": {
"type": [
"boolean",
"null"
]
},
"default_allow_attendee_self_edit": {
"type": [
"boolean",
"null"
]
},
"facebook_handle": {
"type": [
"string",
"null"
],
"description": "Social handles",
"maxLength": 255
},
"instagram_handle": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"twitter_handle": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"linkedin_handle": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"discord_handle": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"tiktok_handle": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"bluesky_handle": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"youtube_handle": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"snapchat_handle": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"twitch_handle": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"reddit_handle": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"pinterest_handle": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"whatsapp_handle": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"telegram_handle": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"vk_handle": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"weibo_handle": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"wechat_handle": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"flickr_handle": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"tumblr_handle": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"quora_handle": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"vimeo_handle": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"github_handle": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"website_url": {
"type": [
"string",
"null"
],
"format": "uri"
},
"homepage_visibility": {
"type": [
"string",
"null"
],
"description": "Homepage",
"enum": [
"PUBLIC",
"PASSWORD_PROTECTED",
null
]
},
"homepage_theme_settings": {
"type": "object",
"description": "Homepage theme settings",
"properties": {
"accent": {
"type": [
"string",
"null"
],
"pattern": "\\#(?:[0-9a-fA-F]{3}){1,2}$|^\\#(?:[0-9a-fA-F]{4}){1,2}$",
"minLength": 4,
"maxLength": 9
},
"background": {
"type": [
"string",
"null"
],
"pattern": "\\#(?:[0-9a-fA-F]{3}){1,2}$|^\\#(?:[0-9a-fA-F]{4}){1,2}$",
"minLength": 4,
"maxLength": 9
},
"mode": {
"type": [
"string",
"null"
],
"enum": [
"light",
"dark",
null
]
},
"background_type": {
"type": [
"string",
"null"
],
"enum": [
"MIRROR_COVER_IMAGE",
"COLOR",
null
]
},
"font_family": {
"type": [
"string",
"null"
],
"enum": [
"Outfit",
"Inter",
"Roboto",
"Open Sans",
"Poppins",
"Montserrat",
"Lato",
"Nunito",
"Raleway",
"DM Sans",
"Plus Jakarta Sans",
"Work Sans",
"Space Grotesk",
"Manrope",
"Oswald",
"Bebas Neue",
"Playfair Display",
"Merriweather",
"Lora",
null
]
}
}
},
"homepage_sections": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]+$",
"maxLength": 40
},
"type": {
"type": "string",
"enum": [
"EVENTS",
"ABOUT",
"CONTACT",
"PAST_EVENTS",
"TEXT",
"GALLERY",
"FAQ",
"VIDEO",
"SPONSORS"
]
},
"enabled": {
"type": "boolean"
},
"heading": {
"type": [
"string",
"null"
],
"maxLength": 100
},
"body": {
"type": [
"string",
"null"
],
"maxLength": 50000
},
"faqs": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"question": {
"type": "string",
"maxLength": 300
},
"answer": {
"type": [
"string",
"null"
],
"maxLength": 5000
}
},
"required": [
"question"
]
},
"maxItems": 50
},
"video_url": {
"type": [
"string",
"null"
],
"format": "uri",
"maxLength": 500
},
"image_ids": {
"type": [
"array",
"null"
],
"items": {
"type": "integer"
},
"maxItems": 40
},
"sponsors": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"image_id": {
"type": "integer"
},
"name": {
"type": [
"string",
"null"
],
"maxLength": 100
},
"url": {
"type": [
"string",
"null"
],
"format": "uri",
"maxLength": 500
}
},
"required": [
"image_id"
]
},
"maxItems": 60
}
},
"required": [
"id",
"type"
]
},
"maxItems": 41
},
"seo_keywords": {
"type": [
"string",
"null"
],
"description": "SEO",
"maxLength": 255
},
"seo_title": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"seo_description": {
"type": [
"string",
"null"
],
"maxLength": 1000
},
"allow_search_engine_indexing": {
"type": [
"boolean",
"null"
]
},
"homepage_password": {
"type": [
"string",
"null"
],
"description": "Password",
"maxLength": 100
},
"tracking_pixels": {
"type": [
"array",
"null"
],
"description": "Tracking pixels",
"items": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"facebook_pixel",
"google_analytics_4",
"google_tag_manager",
"tiktok_pixel"
]
},
"pixel_id": {
"type": "string",
"pattern": "^[a-zA-Z0-9\\-_]+$",
"maxLength": 50
},
"enabled": {
"type": "boolean"
}
},
"required": [
"provider",
"pixel_id",
"enabled"
]
},
"maxItems": 10
},
"tracking_consent_acknowledged": {
"type": [
"boolean",
"null"
]
},
"first_day_of_week": {
"type": "integer",
"minimum": 0,
"maximum": 6
}
},
"title": "PartialUpdateOrganizerSettingsRequest"
},
"PlatformFeePreviewResource": {
"type": "object",
"properties": {
"event_currency": {
"type": "string"
},
"fee_currency": {
"type": [
"string",
"null"
]
},
"fixed_fee_original": {
"type": "number"
},
"fixed_fee_converted": {
"type": "number"
},
"percentage_fee": {
"type": "number"
},
"sample_price": {
"type": "number"
},
"platform_fee": {
"type": "number"
},
"total": {
"type": "number"
}
},
"required": [
"event_currency",
"fee_currency",
"fixed_fee_original",
"fixed_fee_converted",
"percentage_fee",
"sample_price",
"platform_fee",
"total"
],
"title": "PlatformFeePreviewResource"
},
"ProductCategoryResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"is_hidden": {
"type": "boolean"
},
"order": {
"type": "integer"
},
"no_products_message": {
"type": [
"string",
"null"
]
},
"products": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/ProductResource"
}
}
},
"required": [
"id",
"name",
"description",
"is_hidden",
"order",
"no_products_message"
],
"title": "ProductCategoryResource"
},
"ProductCategoryResourcePublic": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"is_hidden": {
"type": "boolean"
},
"order": {
"type": "integer"
},
"no_products_message": {
"type": [
"string",
"null"
]
},
"products": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/ProductResourcePublic"
}
}
},
"required": [
"id",
"name",
"description",
"is_hidden",
"order",
"no_products_message"
],
"title": "ProductCategoryResourcePublic"
},
"ProductMinimalResourcePublic": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string"
},
"event_id": {
"type": "integer"
},
"prices": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/ProductPriceResourcePublic"
}
},
"product_category_id": {
"type": [
"integer",
"null"
]
}
},
"required": [
"id",
"title",
"type",
"event_id",
"product_category_id"
],
"title": "ProductMinimalResourcePublic"
},
"ProductOccurrenceVisibilityResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"event_occurrence_id": {
"type": "integer"
},
"product_id": {
"type": "integer"
},
"created_at": {
"type": "string"
}
},
"required": [
"id",
"event_occurrence_id",
"product_id",
"created_at"
],
"title": "ProductOccurrenceVisibilityResource"
},
"ProductPriceOccurrenceOverrideResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"event_occurrence_id": {
"type": "integer"
},
"product_price_id": {
"type": "integer"
},
"price": {
"type": [
"number",
"null"
]
},
"quantity_available": {
"type": [
"integer",
"null"
]
},
"created_at": {
"type": [
"string",
"null"
]
},
"updated_at": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"event_occurrence_id",
"product_price_id",
"price",
"quantity_available",
"created_at",
"updated_at"
],
"title": "ProductPriceOccurrenceOverrideResource"
},
"ProductPriceResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"label": {
"type": [
"string",
"null"
]
},
"price": {
"type": "number"
},
"sale_start_date": {
"type": [
"string",
"null"
]
},
"sale_end_date": {
"type": [
"string",
"null"
]
},
"is_before_sale_start_date": {
"type": "boolean"
},
"is_after_sale_end_date": {
"type": "boolean"
},
"is_available": {
"type": [
"boolean",
"null"
]
},
"initial_quantity_available": {
"type": [
"integer",
"null"
]
},
"quantity_sold": {
"type": "integer"
},
"quantity_applies_to": {
"type": "string",
"enum": [
"OCCURRENCE",
"EVENT"
]
},
"is_sold_out": {
"type": "boolean"
},
"is_locked_behind_earlier_tier": {
"type": "boolean"
},
"is_hidden": {
"type": [
"boolean",
"null"
]
},
"off_sale_reason": {
"type": [
"string",
"null"
]
},
"price_including_taxes_and_fees": {
"type": "number"
}
},
"required": [
"id",
"label",
"price",
"sale_start_date",
"sale_end_date",
"is_before_sale_start_date",
"is_after_sale_end_date",
"is_available",
"initial_quantity_available",
"quantity_sold",
"quantity_applies_to",
"is_sold_out",
"is_locked_behind_earlier_tier",
"is_hidden",
"off_sale_reason",
"price_including_taxes_and_fees"
],
"title": "ProductPriceResource"
},
"ProductPriceResourcePublic": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"label": {
"type": [
"string",
"null"
]
},
"price": {
"type": "number"
},
"sale_start_date": {
"type": [
"string",
"null"
]
},
"sale_end_date": {
"type": [
"string",
"null"
]
},
"price_including_taxes_and_fees": {
"type": "number"
},
"price_before_discount": {
"type": [
"number",
"null"
]
},
"price_before_discount_including_taxes_and_fees": {
"type": [
"number",
"null"
]
},
"is_discounted": {
"type": "boolean"
},
"tax_total": {
"type": [
"number",
"null"
]
},
"fee_total": {
"type": [
"number",
"null"
]
},
"is_before_sale_start_date": {
"type": "boolean"
},
"is_after_sale_end_date": {
"type": "boolean"
},
"is_available": {
"type": [
"boolean",
"null"
]
},
"is_sold_out": {
"type": "boolean"
},
"quantity_applies_to": {
"type": "string",
"enum": [
"OCCURRENCE",
"EVENT"
]
},
"is_locked_behind_earlier_tier": {
"type": "boolean"
},
"band_prices": {
"type": [
"object",
"null"
],
"additionalProperties": {
"type": "number"
}
},
"quantity_remaining": {
"type": [
"integer",
"null"
]
}
},
"required": [
"id",
"label",
"price",
"sale_start_date",
"sale_end_date",
"price_including_taxes_and_fees",
"price_before_discount",
"price_before_discount_including_taxes_and_fees",
"is_discounted",
"tax_total",
"fee_total",
"is_before_sale_start_date",
"is_after_sale_end_date",
"is_available",
"is_sold_out",
"quantity_applies_to",
"is_locked_behind_earlier_tier",
"band_prices"
],
"title": "ProductPriceResourcePublic"
},
"ProductPurchaseResource": {
"type": "object",
"properties": {
"order_id": {
"type": "integer"
},
"order_public_id": {
"type": "string"
},
"order_status": {
"type": "string",
"enum": [
"COMPLETED",
"CANCELLED",
"AWAITING_OFFLINE_PAYMENT"
]
},
"refund_status": {
"type": [
"string",
"null"
],
"enum": [
"REFUND_PENDING",
"REFUND_FAILED",
"REFUNDED",
"PARTIALLY_REFUNDED",
null
]
},
"order_created_at": {
"type": "string"
},
"currency": {
"type": "string"
},
"first_name": {
"type": [
"string",
"null"
]
},
"last_name": {
"type": [
"string",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
},
"product_title": {
"type": "string"
},
"product_price_id": {
"type": [
"integer",
"null"
]
},
"price_label": {
"type": [
"string",
"null"
]
},
"event_occurrence_id": {
"type": [
"integer",
"null"
]
},
"occurrence_start_date": {
"type": [
"string",
"null"
]
},
"sold_quantity": {
"type": "integer"
},
"awaiting_payment_quantity": {
"type": "integer"
},
"cancelled_quantity": {
"type": "integer"
},
"line_total": {
"type": [
"number",
"null"
]
},
"status": {
"type": "string",
"enum": [
"SOLD",
"AWAITING_PAYMENT",
"CANCELLED"
]
}
},
"required": [
"order_id",
"order_public_id",
"order_status",
"refund_status",
"order_created_at",
"currency",
"first_name",
"last_name",
"email",
"product_title",
"product_price_id",
"price_label",
"event_occurrence_id",
"occurrence_start_date",
"sold_quantity",
"awaiting_payment_quantity",
"cancelled_quantity",
"line_total",
"status"
],
"title": "ProductPurchaseResource"
},
"ProductPurchaseSummaryResource": {
"type": "object",
"properties": {
"sold_quantity": {
"type": "integer"
},
"awaiting_payment_quantity": {
"type": "integer"
},
"cancelled_quantity": {
"type": "integer"
},
"buyer_count": {
"type": "integer"
},
"gross_sales": {
"type": "number"
},
"refunded_order_count": {
"type": "integer"
}
},
"required": [
"sold_quantity",
"awaiting_payment_quantity",
"cancelled_quantity",
"buyer_count",
"gross_sales",
"refunded_order_count"
],
"title": "ProductPurchaseSummaryResource"
},
"ProductResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"PAID",
"FREE",
"DONATION",
"TIERED",
"REGISTRATION"
]
},
"product_type": {
"type": "string",
"enum": [
"TICKET",
"GENERAL"
]
},
"order": {
"type": "integer"
},
"description": {
"type": [
"string",
"null"
]
},
"price": {
"type": [
"number",
"null"
]
},
"max_per_order": {
"type": "integer"
},
"min_per_order": {
"type": "integer"
},
"quantity_sold": {
"type": "integer"
},
"sale_start_date": {
"type": [
"string",
"null"
]
},
"sale_end_date": {
"type": [
"string",
"null"
]
},
"event_id": {
"type": "integer"
},
"initial_quantity_available": {
"type": [
"integer",
"null"
]
},
"hide_before_sale_start_date": {
"type": "boolean"
},
"hide_after_sale_end_date": {
"type": "boolean"
},
"start_collapsed": {
"type": "boolean"
},
"show_quantity_remaining": {
"type": "boolean"
},
"hide_when_sold_out": {
"type": "boolean"
},
"sequential_tier_release_enabled": {
"type": "boolean"
},
"is_hidden_without_promo_code": {
"type": "boolean"
},
"is_hidden": {
"type": [
"boolean",
"null"
]
},
"is_before_sale_start_date": {
"type": "boolean"
},
"is_after_sale_end_date": {
"type": "boolean"
},
"is_available": {
"type": "boolean"
},
"is_sold_out": {
"type": "boolean"
},
"taxes_and_fees": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/TaxAndFeeResource"
}
},
"prices": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/ProductPriceResource"
}
},
"product_category_id": {
"type": [
"integer",
"null"
]
},
"is_highlighted": {
"type": "boolean"
},
"highlight_message": {
"type": [
"string",
"null"
]
},
"waitlist_enabled": {
"type": [
"boolean",
"null"
]
},
"is_addon_only": {
"type": "boolean"
},
"addon_product_ids": {
"type": [
"array",
"null"
],
"items": {}
},
"addons": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"title": {
"type": "string"
}
},
"required": [
"id",
"title"
]
}
}
},
"required": [
"id",
"title",
"type",
"product_type",
"order",
"description",
"max_per_order",
"min_per_order",
"quantity_sold",
"sale_start_date",
"sale_end_date",
"event_id",
"initial_quantity_available",
"hide_before_sale_start_date",
"hide_after_sale_end_date",
"start_collapsed",
"show_quantity_remaining",
"hide_when_sold_out",
"sequential_tier_release_enabled",
"is_hidden_without_promo_code",
"is_hidden",
"is_before_sale_start_date",
"is_after_sale_end_date",
"is_available",
"product_category_id",
"is_highlighted",
"highlight_message",
"waitlist_enabled",
"is_addon_only"
],
"title": "ProductResource"
},
"ProductResourcePublic": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"PAID",
"FREE",
"DONATION",
"TIERED",
"REGISTRATION"
]
},
"product_type": {
"type": "string",
"enum": [
"TICKET",
"GENERAL"
]
},
"description": {
"type": [
"string",
"null"
]
},
"max_per_order": {
"type": [
"integer",
"null"
]
},
"min_per_order": {
"type": [
"integer",
"null"
]
},
"sale_start_date": {
"type": [
"string",
"null"
]
},
"sale_end_date": {
"type": [
"string",
"null"
]
},
"event_id": {
"type": "integer"
},
"is_before_sale_start_date": {
"type": "boolean"
},
"is_after_sale_end_date": {
"type": "boolean"
},
"start_collapsed": {
"type": "boolean"
},
"quantity_available": {
"type": "integer"
},
"price": {
"type": [
"number",
"null"
]
},
"prices": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/components/schemas/ProductPriceResourcePublic"
}
},
"taxes": {
"type": [
"array",
"null"
],
"description": "todo: this should be taxes_and_fees",
"items": {
"$ref": "#/components/schemas/TaxAndFeeResource"
}
},
"is_available": {
"type": "boolean"
},
"is_sold_out": {
"type": "boolean"
},
"product_category_id": {
"type": [
"integer",
"null"
]
},
"is_highlighted": {
"type": "boolean"
},
"highlight_message": {
"type": [
"string",
"null"
]
},
"waitlist_enabled": {
"type": [
"boolean",
"null"
]
},
"is_addon_only": {
"type": "boolean"
},
"addon_product_ids": {
"type": [
"array",
"null"
],
"items": {}
}
},
"required": [
"id",
"title",
"type",
"product_type",
"description",
"max_per_order",
"min_per_order",
"sale_start_date",
"sale_end_date",
"event_id",
"is_before_sale_start_date",
"is_after_sale_end_date",
"start_collapsed",
"product_category_id",
"is_highlighted",
"highlight_message",
"waitlist_enabled",
"is_addon_only"
],
"title": "ProductResourcePublic"
},
"ProfileResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"organizer_id": {
"type": "integer"
},
"name": {
"type": "string"
},
"tagline": {
"type": [
"string",
"null"
]
},
"bio": {
"type": [
"string",
"null"
]
},
"links": {
"anyOf": [
{
"type": "string"
},
{
"type": "object"
},
{
"type": "array",
"items": {}
}
]
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageResource"
}
},
"appearances": {
"type": "array",
"items": {
"type": "object",
"properties": {
"event_id": {
"type": "integer"
},
"event_title": {
"type": [
"string",
"null"
]
},
"event_status": {
"type": "string",
"enum": [
"DRAFT",
"LIVE",
"ARCHIVED",
"PENDING_MANUAL_REVIEW"
]
},
"billing_tier": {
"type": "string"
},
"role_label": {
"type": [
"string",
"null"
]
},
"is_hidden": {
"type": "boolean"
}
},
"required": [
"event_id",
"event_title",
"event_status",
"billing_tier",
"role_label",
"is_hidden"
]
}
},
"created_at": {
"type": [
"string",
"null"
]
},
"updated_at": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"organizer_id",
"name",
"tagline",
"bio",
"links",
"images",
"created_at",
"updated_at"
],
"title": "ProfileResource"
},
"ProfileResourcePublic": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"tagline": {
"type": [
"string",
"null"
]
},
"bio": {
"type": [
"string",
"null"
]
},
"links": {
"anyOf": [
{
"type": "string"
},
{
"type": "object"
},
{
"type": "array",
"items": {}
}
]
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImageResource"
}
}
},
"required": [
"id",
"name",
"tagline",
"bio",
"links",
"images"
],
"title": "ProfileResourcePublic"
},
"PromoCodeResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"code": {
"type": "string"
},
"applicable_product_ids": {
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {}
},
{
"type": "string"
},
{
"type": "object"
}
]
},
"discount": {
"type": "number"
},
"discount_type": {
"type": [
"string",
"null"
]
},
"discount_applies_to": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": [
"string",
"null"
]
},
"expiry_date": {
"type": [
"string",
"null"
]
},
"attendee_usage_count": {
"type": "integer"
},
"order_usage_count": {
"type": "integer"
},
"max_allowed_usages": {
"type": [
"integer",
"null"
]
}
},
"required": [
"id",
"code",
"applicable_product_ids",
"discount",
"discount_type",
"discount_applies_to",
"created_at",
"updated_at",
"expiry_date",
"attendee_usage_count",
"order_usage_count",
"max_allowed_usages"
],
"title": "PromoCodeResource"
},
"QuestionAnswerViewResource": {
"type": "object",
"properties": {
"product_id": {
"type": [
"integer",
"null"
]
},
"product_title": {
"type": [
"string",
"null"
]
},
"question_id": {
"type": "integer"
},
"title": {
"type": "string"
},
"question_required": {
"type": "boolean"
},
"question_description": {
"type": [
"string",
"null"
]
},
"answer": {
"anyOf": [
{
"type": "array",
"items": {}
},
{
"type": "string"
}
]
},
"text_answer": {
"type": "string"
},
"order_id": {
"type": [
"integer",
"null"
]
},
"belongs_to": {
"type": "string"
},
"question_type": {
"type": "string"
},
"event_id": {
"type": "integer"
},
"question_answer_id": {
"type": "integer"
},
"question_options": {
"type": [
"array",
"null"
],
"items": {}
},
"attendee_id": {
"type": [
"integer",
"null"
]
},
"first_name": {
"type": [
"string",
"null"
]
},
"last_name": {
"type": [
"string",
"null"
]
},
"attendee_public_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"product_id",
"product_title",
"question_id",
"title",
"question_required",
"question_description",
"answer",
"text_answer",
"order_id",
"belongs_to",
"question_type",
"event_id",
"question_answer_id",
"question_options"
],
"title": "QuestionAnswerViewResource"
},
"QuestionResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": [
"string",
"null"
]
},
"title": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"options": {
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {}
},
{
"type": "string"
},
{
"type": "object"
}
]
},
"required": {
"type": "boolean"
},
"event_id": {
"type": "integer"
},
"belongs_to": {
"type": "string"
},
"is_hidden": {
"type": "boolean"
},
"product_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"id",
"type",
"title",
"description",
"options",
"required",
"event_id",
"belongs_to",
"is_hidden"
],
"title": "QuestionResource"
},
"QuestionResourcePublic": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": [
"string",
"null"
]
},
"title": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"options": {
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {}
},
{
"type": "string"
},
{
"type": "object"
}
]
},
"required": {
"type": "boolean"
},
"event_id": {
"type": "integer"
},
"belongs_to": {
"type": "string"
},
"order": {
"type": "integer"
},
"product_ids": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"id",
"type",
"title",
"description",
"options",
"required",
"event_id",
"belongs_to",
"order"
],
"title": "QuestionResourcePublic"
},
"RefundOrderRequest": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"notify_buyer": {
"type": "boolean"
},
"cancel_order": {
"type": "boolean"
}
},
"required": [
"amount",
"notify_buyer",
"cancel_order"
],
"title": "RefundOrderRequest"
},
"ReportOfflinePaymentRequest": {
"type": "object",
"properties": {
"note": {
"type": [
"string",
"null"
],
"maxLength": 100
}
},
"title": "ReportOfflinePaymentRequest"
},
"ScheduleItemResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"title": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"starts_at": {
"type": "string"
},
"ends_at": {
"type": "string"
},
"event_space_id": {
"type": [
"integer",
"null"
]
},
"lineup_entry_ids": {
"type": "array",
"items": {
"type": "integer"
}
}
},
"required": [
"id",
"title",
"description",
"starts_at",
"ends_at",
"event_space_id",
"lineup_entry_ids"
],
"title": "ScheduleItemResource"
},
"SeatAvailabilityResourcePublic": {
"type": "object",
"properties": {
"version": {
"type": "integer"
},
"unavailable_seat_uids": {
"type": "array",
"items": {
"type": "string"
}
},
"zone_remaining": {
"type": "string"
},
"band_free": {
"type": "string"
}
},
"required": [
"version",
"unavailable_seat_uids",
"zone_remaining",
"band_free"
],
"title": "SeatAvailabilityResourcePublic"
},
"SeatBlockRequest": {
"type": "object",
"properties": {
"all_upcoming_dates": {
"type": "boolean"
},
"event_occurrence_ids": {
"type": "array",
"items": {
"type": "integer"
},
"minItems": 1,
"maxItems": 1200
},
"seat_uids": {
"type": "array",
"items": {
"type": "string",
"maxLength": 24
},
"minItems": 1,
"maxItems": 500
},
"reason": {
"type": [
"string",
"null"
],
"maxLength": 255
}
},
"required": [
"seat_uids"
],
"title": "SeatBlockRequest"
},
"SeatMapDiffResource": {
"type": "object",
"properties": {
"added_seat_count": {
"type": "integer"
},
"removed_seat_labels": {
"type": "array",
"items": {
"type": "string"
}
},
"relabelled_seat_count": {
"type": "integer"
},
"rebanded_seat_count": {
"type": "integer"
}
},
"required": [
"added_seat_count",
"removed_seat_labels",
"relabelled_seat_count",
"rebanded_seat_count"
],
"title": "SeatMapDiffResource"
},
"SeatMapPreviewResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"organizer_id": {
"type": "integer"
},
"name": {
"type": "string"
},
"version": {
"type": "integer"
},
"seat_count": {
"type": "integer"
},
"created_at": {
"type": [
"string",
"null"
]
},
"updated_at": {
"type": [
"string",
"null"
]
},
"preview_layout": {
"type": "object"
}
},
"required": [
"id",
"organizer_id",
"name",
"version",
"seat_count",
"created_at",
"updated_at",
"preview_layout"
],
"title": "SeatMapPreviewResource"
},
"SeatMapResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"organizer_id": {
"type": "integer"
},
"name": {
"type": "string"
},
"version": {
"type": "integer"
},
"seat_count": {
"type": "integer"
},
"created_at": {
"type": [
"string",
"null"
]
},
"updated_at": {
"type": [
"string",
"null"
]
},
"layout": {
"type": "object"
}
},
"required": [
"id",
"organizer_id",
"name",
"version",
"seat_count",
"created_at",
"updated_at",
"layout"
],
"title": "SeatMapResource"
},
"SendMessageRequest": {
"type": "object",
"properties": {
"subject": {
"type": "string",
"maxLength": 100
},
"message": {
"type": "string",
"maxLength": 8000
},
"message_type": {
"type": "string",
"enum": [
"ORDER_OWNER",
"TICKET_HOLDERS",
"INDIVIDUAL_ATTENDEES",
"ALL_ATTENDEES",
"ORDER_OWNERS_WITH_PRODUCT"
]
},
"is_test": {
"type": "boolean"
},
"send_copy_to_current_user": {
"type": "boolean"
},
"attendee_ids": {
"type": "array",
"items": {
"type": "integer"
},
"maxItems": 50
},
"product_ids": {
"type": "array",
"items": {
"type": "integer"
}
},
"order_id": {
"type": "integer"
},
"order_statuses": {
"type": "object"
},
"scheduled_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"event_occurrence_id": {
"type": [
"integer",
"null"
]
},
"event_occurrence_ids": {
"type": [
"array",
"null"
],
"items": {
"type": "integer"
},
"maxItems": 500
}
},
"required": [
"subject",
"message",
"message_type"
],
"title": "SendMessageRequest"
},
"SendTicketLookupEmailRequest": {
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email"
}
},
"required": [
"email"
],
"title": "SendTicketLookupEmailRequest"
},
"SortLineupEntriesRequest": {
"type": "object",
"properties": {
"sorted_ids": {
"type": "array",
"items": {
"type": "integer"
},
"minItems": 1,
"maxItems": 1000
}
},
"required": [
"sorted_ids"
],
"title": "SortLineupEntriesRequest"
},
"SortProductsRequest": {
"type": "object",
"properties": {
"sorted_categories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"product_category_id": {
"type": "integer"
},
"sorted_products": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"order": {
"type": "integer"
}
},
"required": [
"id"
]
}
}
},
"required": [
"product_category_id"
]
},
"minItems": 1
}
},
"required": [
"sorted_categories"
],
"title": "SortProductsRequest"
},
"SortProfileImagesRequest": {
"type": "object",
"properties": {
"sorted_ids": {
"type": "array",
"items": {
"type": "integer"
},
"minItems": 1,
"maxItems": 50
}
},
"required": [
"sorted_ids"
],
"title": "SortProfileImagesRequest"
},
"SortQuestionsRequest": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"order": {
"type": "integer"
}
},
"required": [
"id",
"order"
]
},
"title": "SortQuestionsRequest"
},
"TaxAndFeeResource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"account_id": {
"type": "integer"
},
"name": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"calculation_type": {
"type": "string"
},
"rate": {
"type": "number"
},
"is_active": {
"type": [
"boolean",
"null"
]
},
"is_default": {
"type": "boolean"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"account_id",
"name",
"description",
"calculation_type",
"rate",
"is_active",
"is_default",
"type"
],
"title": "TaxAndFeeResource"
},
"UpdateAffiliateRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 255
},
"email": {
"type": [
"string",
"null"
],
"format": "email",
"maxLength": 255
},
"status": {
"type": [
"string",
"null"
],
"enum": [
"ACTIVE",
"INACTIVE",
null
]
}
},
"title": "UpdateAffiliateRequest"
},
"UpdateEventLocationRequest": {
"type": "object",
"properties": {
"event_location": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"IN_PERSON",
"ONLINE"
]
},
"location_id": {
"type": [
"integer",
"null"
]
},
"online_event_connection_details": {
"type": [
"string",
"null"
],
"maxLength": 10000
}
}
},
"clear_event_location": {
"type": "boolean"
}
},
"title": "UpdateEventLocationRequest"
},
"UpdateEventRequest": {
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"maxLength": 150
},
"description": {
"type": [
"string",
"null"
],
"minLength": 1,
"maxLength": 50000
},
"start_date": {
"type": "string",
"format": "date-time"
},
"end_date": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"type": {
"type": [
"string",
"null"
],
"enum": [
"SINGLE",
"RECURRING",
null
]
},
"timezone": {
"type": "string"
},
"currency": {
"type": "string",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"AOA",
"ARS",
"AUD",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BWP",
"BYN",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"GBP",
"GEL",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HUF",
"IDR",
"ILS",
"INR",
"IQD",
"ISK",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"STD",
"SVC",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VND",
"VUV",
"WST",
"XCD",
"XAF",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW"
]
},
"category": {
"type": [
"string",
"null"
],
"enum": [
"SOCIAL",
"FAMILY",
"HOBBIES",
"FOOD_DRINK",
"WELLNESS",
"SPIRITUALITY",
"OUTDOORS",
"TOURS",
"CHARITY",
"MUSIC",
"ART",
"COMEDY",
"THEATER",
"FILM",
"DANCE",
"BUSINESS",
"TECH",
"EDUCATION",
"WORKSHOP",
"SPORTS",
"FESTIVAL",
"SEASONAL",
"NIGHTLIFE",
"OTHER",
null
]
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "todo - Revisit the 50k character limit",
"minLength": 1,
"maxLength": 50
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 1000
},
"is_public": {
"type": "boolean"
}
},
"required": [
"name",
"value",
"is_public"
]
}
}
},
"required": [
"title",
"start_date"
],
"title": "UpdateEventRequest"
},
"UpdateEventSeatMapBandProductsRequest": {
"type": "object",
"properties": {
"band_products": {
"type": "array",
"items": {
"type": "object",
"properties": {
"band_key": {
"type": "string",
"maxLength": 24
},
"products": {
"type": "array",
"items": {
"type": "object",
"properties": {
"product_id": {
"type": "integer"
},
"price_adjustment": {
"type": "integer",
"minimum": -10000000,
"maximum": 10000000
}
},
"required": [
"product_id"
]
}
}
},
"required": [
"band_key",
"products"
]
},
"maxItems": 20
}
},
"required": [
"band_products"
],
"title": "UpdateEventSeatMapBandProductsRequest"
},
"UpdateEventSeatMapLayoutRequest": {
"type": "object",
"properties": {
"version": {
"type": [
"integer",
"null"
]
},
"confirm_relabel": {
"type": [
"boolean",
"null"
]
},
"layout": {
"type": "object",
"properties": {
"schema": {
"type": "integer"
},
"bands": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
},
"areas": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
}
},
"required": [
"schema",
"bands",
"areas"
]
}
},
"required": [
"layout"
],
"title": "UpdateEventSeatMapLayoutRequest"
},
"UpdateEventSettingsRequest": {
"type": "object",
"properties": {
"post_checkout_message": {
"type": [
"string",
"null"
]
},
"pre_checkout_message": {
"type": [
"string",
"null"
]
},
"email_footer_message": {
"type": [
"string",
"null"
]
},
"continue_button_text": {
"type": [
"string",
"null"
],
"maxLength": 100
},
"get_tickets_button_text": {
"type": [
"string",
"null"
],
"maxLength": 100
},
"support_email": {
"type": [
"string",
"null"
],
"format": "email"
},
"require_attendee_details": {
"type": "boolean"
},
"attendee_details_collection_method": {
"type": "string",
"enum": [
"PER_TICKET",
"PER_ORDER"
]
},
"order_timeout_in_minutes": {
"type": "number",
"minimum": 1,
"maximum": 120
},
"homepage_background_color": {
"type": [
"string",
"null"
],
"pattern": "\\#(?:[0-9a-fA-F]{3}){1,2}$|^\\#(?:[0-9a-fA-F]{4}){1,2}$",
"minLength": 4,
"maxLength": 9
},
"homepage_primary_color": {
"type": [
"string",
"null"
],
"pattern": "\\#(?:[0-9a-fA-F]{3}){1,2}$|^\\#(?:[0-9a-fA-F]{4}){1,2}$",
"minLength": 4,
"maxLength": 9
},
"homepage_primary_text_color": {
"type": [
"string",
"null"
],
"pattern": "\\#(?:[0-9a-fA-F]{3}){1,2}$|^\\#(?:[0-9a-fA-F]{4}){1,2}$",
"minLength": 4,
"maxLength": 9
},
"homepage_secondary_color": {
"type": [
"string",
"null"
],
"pattern": "\\#(?:[0-9a-fA-F]{3}){1,2}$|^\\#(?:[0-9a-fA-F]{4}){1,2}$",
"minLength": 4,
"maxLength": 9
},
"homepage_secondary_text_color": {
"type": [
"string",
"null"
],
"pattern": "\\#(?:[0-9a-fA-F]{3}){1,2}$|^\\#(?:[0-9a-fA-F]{4}){1,2}$",
"minLength": 4,
"maxLength": 9
},
"homepage_body_background_color": {
"type": [
"string",
"null"
],
"pattern": "\\#(?:[0-9a-fA-F]{3}){1,2}$|^\\#(?:[0-9a-fA-F]{4}){1,2}$",
"minLength": 4,
"maxLength": 9
},
"homepage_background_type": {
"type": [
"string",
"null"
],
"enum": [
"MIRROR_COVER_IMAGE",
"COLOR",
null
]
},
"website_url": {
"type": [
"string",
"null"
],
"format": "uri"
},
"maps_url": {
"type": [
"string",
"null"
],
"format": "uri"
},
"seo_title": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"seo_description": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"seo_keywords": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"allow_search_engine_indexing": {
"type": "boolean"
},
"notify_organizer_of_new_orders": {
"type": "boolean"
},
"price_display_mode": {
"type": "string",
"enum": [
"INCLUSIVE",
"EXCLUSIVE"
]
},
"payment_providers": {
"type": "array",
"description": "Payment settings",
"items": {
"type": "string",
"enum": [
"STRIPE",
"OFFLINE"
]
}
},
"offline_payment_instructions": {
"type": [
"string",
"null"
]
},
"allow_orders_awaiting_offline_payment_to_check_in": {
"type": "boolean"
},
"offline_payment_reporting_enabled": {
"type": "boolean"
},
"offline_payment_order_reference_enabled": {
"type": "boolean"
},
"payment_links_enabled": {
"type": "boolean"
},
"payment_link_expiry_hours": {
"type": "integer",
"minimum": 1,
"maximum": 720
},
"enable_invoicing": {
"type": "boolean",
"description": "Invoice settings"
},
"invoice_label": {
"type": [
"string",
"null"
],
"maxLength": 50
},
"invoice_prefix": {
"type": [
"string",
"null"
],
"pattern": "^[A-Za-z0-9\\-]*$",
"maxLength": 10
},
"invoice_start_number": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"require_billing_address": {
"type": "boolean"
},
"organization_name": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"organization_address": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"invoice_tax_details": {
"type": [
"string",
"null"
]
},
"invoice_notes": {
"type": [
"string",
"null"
]
},
"invoice_payment_terms_days": {
"type": [
"integer",
"null"
]
},
"ticket_design_settings": {
"type": "object",
"description": "Ticket design settings",
"properties": {
"accent_color": {
"type": [
"string",
"null"
],
"pattern": "\\#(?:[0-9a-fA-F]{3}){1,2}$|^\\#(?:[0-9a-fA-F]{4}){1,2}$",
"minLength": 4,
"maxLength": 9
},
"logo_image_id": {
"type": [
"integer",
"null"
]
},
"footer_text": {
"type": [
"string",
"null"
],
"maxLength": 500
},
"layout_type": {
"type": [
"string",
"null"
],
"enum": [
"default",
"modern",
null
]
},
"date_display_mode": {
"type": [
"string",
"null"
],
"enum": [
"START_DATE_TIME",
"DATE_RANGE",
"HIDDEN",
null
]
},
"enabled": {
"type": "boolean"
}
}
},
"show_marketing_opt_in": {
"type": "boolean",
"description": "Marketing settings"
},
"allow_copy_details_to_all_attendees": {
"type": "boolean",
"description": "Attendee detail copy control"
},
"pass_platform_fee_to_buyer": {
"type": "boolean",
"description": "Platform fee settings"
},
"homepage_theme_settings": {
"type": "object",
"description": "Homepage theme settings",
"properties": {
"accent": {
"type": [
"string",
"null"
],
"pattern": "\\#(?:[0-9a-fA-F]{3}){1,2}$|^\\#(?:[0-9a-fA-F]{4}){1,2}$",
"minLength": 4,
"maxLength": 9
},
"background": {
"type": [
"string",
"null"
],
"pattern": "\\#(?:[0-9a-fA-F]{3}){1,2}$|^\\#(?:[0-9a-fA-F]{4}){1,2}$",
"minLength": 4,
"maxLength": 9
},
"mode": {
"type": [
"string",
"null"
],
"enum": [
"light",
"dark",
null
]
},
"background_type": {
"type": [
"string",
"null"
],
"enum": [
"MIRROR_COVER_IMAGE",
"COLOR",
null
]
},
"font_family": {
"type": [
"string",
"null"
],
"enum": [
"Outfit",
"Inter",
"Roboto",
"Open Sans",
"Poppins",
"Montserrat",
"Lato",
"Nunito",
"Raleway",
"DM Sans",
"Plus Jakarta Sans",
"Work Sans",
"Space Grotesk",
"Manrope",
"Oswald",
"Bebas Neue",
"Playfair Display",
"Merriweather",
"Lora",
null
]
},
"layout": {
"type": [
"string",
"null"
],
"enum": [
"MARQUEE",
"FLYER",
"STORY",
"INVITE",
null
]
}
}
},
"homepage_sections": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]+$",
"maxLength": 40
},
"type": {
"type": "string",
"enum": [
"TICKETS",
"ABOUT",
"LINEUP",
"SCHEDULE",
"LOCATION",
"ORGANIZER",
"MORE_EVENTS",
"TEXT",
"GALLERY",
"FAQ",
"VIDEO",
"SPONSORS"
]
},
"enabled": {
"type": "boolean"
},
"heading": {
"type": [
"string",
"null"
],
"maxLength": 100
},
"body": {
"type": [
"string",
"null"
],
"maxLength": 50000
},
"faqs": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"question": {
"type": "string",
"maxLength": 300
},
"answer": {
"type": [
"string",
"null"
],
"maxLength": 5000
}
},
"required": [
"question"
]
},
"maxItems": 50
},
"video_url": {
"type": [
"string",
"null"
],
"format": "uri",
"maxLength": 500
},
"image_ids": {
"type": [
"array",
"null"
],
"items": {
"type": "integer"
},
"maxItems": 40
},
"sponsors": {
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"image_id": {
"type": "integer"
},
"name": {
"type": [
"string",
"null"
],
"maxLength": 100
},
"url": {
"type": [
"string",
"null"
],
"format": "uri",
"maxLength": 500
}
},
"required": [
"image_id"
]
},
"maxItems": 60
}
},
"required": [
"id",
"type"
]
},
"maxItems": 41
},
"allow_attendee_self_edit": {
"type": "boolean",
"description": "Self-service settings"
},
"show_available_occurrence_capacity": {
"type": "boolean",
"description": "Occurrence display"
},
"hide_sold_out_occurrences": {
"type": "boolean"
},
"waitlist_auto_process": {
"type": "boolean",
"description": "Waitlist settings"
},
"waitlist_offer_timeout_minutes": {
"type": [
"integer",
"null"
],
"minimum": 1,
"maximum": 10080
}
},
"title": "UpdateEventSettingsRequest"
},
"UpdateEventStatusRequest": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"DRAFT",
"LIVE",
"ARCHIVED"
]
}
},
"required": [
"status"
],
"title": "UpdateEventStatusRequest"
},
"UpdateEventTypeRequest": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"SINGLE",
"RECURRING"
]
}
},
"required": [
"type"
],
"title": "UpdateEventTypeRequest"
},
"UpdateLineupEntryRequest": {
"type": "object",
"properties": {
"billing_tier": {
"$ref": "#/components/schemas/LineupBillingTier"
},
"role_label": {
"type": [
"string",
"null"
],
"maxLength": 100
},
"is_hidden": {
"type": "boolean"
}
},
"required": [
"billing_tier"
],
"title": "UpdateLineupEntryRequest"
},
"UpdateOrganizerLocationRequest": {
"type": "object",
"properties": {
"location_id": {
"type": [
"integer",
"null"
]
}
},
"title": "UpdateOrganizerLocationRequest"
},
"UpdateOrganizerStatusRequest": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"DRAFT",
"LIVE",
"ARCHIVED"
]
}
},
"required": [
"status"
],
"title": "UpdateOrganizerStatusRequest"
},
"UpdateProductVisibilityRequest": {
"type": "object",
"properties": {
"product_ids": {
"type": "array",
"items": {
"type": "integer"
},
"minItems": 1
}
},
"required": [
"product_ids"
],
"title": "UpdateProductVisibilityRequest"
},
"UpsertBoxOfficeRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": [
"string",
"null"
],
"maxLength": 2000
},
"product_ids": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"event_occurrence_id": {
"type": [
"integer",
"null"
]
},
"check_in_list_id": {
"type": [
"integer",
"null"
]
},
"allow_price_override": {
"type": [
"boolean",
"null"
]
},
"allow_discounts": {
"type": [
"boolean",
"null"
]
},
"collect_order_questions": {
"type": [
"boolean",
"null"
]
},
"activates_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"expires_at": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
"name"
],
"title": "UpsertBoxOfficeRequest"
},
"UpsertCapacityAssignmentRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"capacity": {
"type": [
"number",
"null"
],
"minimum": 1
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"INACTIVE"
]
},
"product_ids": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
}
},
"required": [
"name",
"status",
"product_ids"
],
"title": "UpsertCapacityAssignmentRequest"
},
"UpsertCheckInListRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"description": {
"type": [
"string",
"null"
],
"maxLength": 2000
},
"expires_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"activates_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"product_ids": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
},
"event_occurrence_id": {
"type": [
"integer",
"null"
]
},
"public_show_attendee_notes": {
"type": [
"boolean",
"null"
]
},
"public_show_question_answers": {
"type": [
"boolean",
"null"
]
},
"public_show_order_details": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"name"
],
"title": "UpsertCheckInListRequest"
},
"UpsertEventOccurrenceRequest": {
"type": "object",
"properties": {
"start_date": {
"type": "string",
"format": "date-time"
},
"end_date": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"capacity": {
"type": [
"integer",
"null"
],
"minimum": 0
},
"label": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"show_available_capacity": {
"type": [
"boolean",
"null"
]
},
"event_location": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"IN_PERSON",
"ONLINE"
]
},
"location_id": {
"type": [
"integer",
"null"
]
},
"online_event_connection_details": {
"type": [
"string",
"null"
],
"maxLength": 10000
}
}
},
"clear_event_location": {
"type": "boolean"
}
},
"required": [
"start_date"
],
"title": "UpsertEventOccurrenceRequest"
},
"UpsertEventSpaceRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 100
},
"event_location_id": {
"type": [
"integer",
"null"
]
}
},
"required": [
"name"
],
"title": "UpsertEventSpaceRequest"
},
"UpsertEventWidgetRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 100
},
"type": {
"type": "string",
"enum": [
"TICKETS",
"BUTTON",
"LINEUP",
"SCHEDULE"
]
},
"settings": {
"type": "object",
"properties": {
"background_color": {
"type": [
"string",
"null"
],
"pattern": "^#([0-9a-f]{3,4}|[0-9a-f]{6}|[0-9a-f]{8})$"
},
"primary_color": {
"type": [
"string",
"null"
],
"pattern": "^#([0-9a-f]{3,4}|[0-9a-f]{6}|[0-9a-f]{8})$"
},
"primary_text_color": {
"type": [
"string",
"null"
],
"pattern": "^#([0-9a-f]{3,4}|[0-9a-f]{6}|[0-9a-f]{8})$"
},
"secondary_color": {
"type": [
"string",
"null"
],
"pattern": "^#([0-9a-f]{3,4}|[0-9a-f]{6}|[0-9a-f]{8})$"
},
"secondary_text_color": {
"type": [
"string",
"null"
],
"pattern": "^#([0-9a-f]{3,4}|[0-9a-f]{6}|[0-9a-f]{8})$"
},
"padding": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 500
},
"radius": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 32
},
"continue_button_text": {
"type": [
"string",
"null"
],
"maxLength": 100
},
"button_text": {
"type": [
"string",
"null"
],
"maxLength": 100
},
"checkout": {
"type": [
"string",
"null"
],
"enum": [
"modal",
"new-tab",
null
]
},
"autoresize": {
"type": [
"boolean",
"null"
]
},
"show_lineup": {
"type": [
"boolean",
"null"
]
},
"hide_promo_code": {
"type": [
"boolean",
"null"
]
},
"hide_category_titles": {
"type": [
"boolean",
"null"
]
},
"theme": {
"type": [
"string",
"null"
],
"enum": [
"custom",
"event",
null
]
},
"font": {
"type": [
"string",
"null"
],
"enum": [
"Outfit",
"Inter",
"Roboto",
"Open Sans",
"Poppins",
"Montserrat",
"Lato",
"Nunito",
"Raleway",
"DM Sans",
"Plus Jakarta Sans",
"Work Sans",
"Space Grotesk",
"Manrope",
"Oswald",
"Bebas Neue",
"Playfair Display",
"Merriweather",
"Lora",
null
]
},
"locale": {
"type": [
"string",
"null"
],
"enum": [
"en",
"de",
"fi",
"fr",
"it",
"nl",
"hu",
"es",
"pt",
"pt-br",
"zh-cn",
"se",
"zh-hk",
"vi",
"tr",
"pl",
"sk",
"el",
"ko",
"ja",
null
]
},
"sections": {
"type": [
"array",
"null"
],
"items": {
"type": "string",
"enum": [
"tickets",
"header",
"about",
"location",
"organizer",
"lineup",
"schedule",
"custom"
]
},
"maxItems": 8
},
"promo_code": {
"type": [
"string",
"null"
],
"maxLength": 50
},
"products": {
"type": [
"array",
"null"
],
"items": {
"type": "integer",
"minimum": 1
},
"maxItems": 100
},
"categories": {
"type": [
"array",
"null"
],
"items": {
"type": "integer",
"minimum": 1
},
"maxItems": 100
},
"occurrence_id": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"layout": {
"type": [
"string",
"null"
],
"enum": [
"list",
"grid",
"compact",
null
]
},
"limit": {
"type": [
"integer",
"null"
],
"minimum": 1,
"maximum": 50
},
"event_category": {
"type": [
"string",
"null"
],
"enum": [
"SOCIAL",
"FAMILY",
"HOBBIES",
"FOOD_DRINK",
"WELLNESS",
"SPIRITUALITY",
"OUTDOORS",
"TOURS",
"CHARITY",
"MUSIC",
"ART",
"COMEDY",
"THEATER",
"FILM",
"DANCE",
"BUSINESS",
"TECH",
"EDUCATION",
"WORKSHOP",
"SPORTS",
"FESTIVAL",
"SEASONAL",
"NIGHTLIFE",
"OTHER",
null
]
},
"show_past": {
"type": [
"boolean",
"null"
]
},
"open_in": {
"type": [
"string",
"null"
],
"enum": [
"popup",
"page",
null
]
}
},
"required": [
"background_color",
"primary_color",
"primary_text_color",
"secondary_color",
"secondary_text_color",
"padding",
"radius",
"continue_button_text",
"button_text",
"checkout",
"autoresize",
"show_lineup",
"hide_promo_code",
"hide_category_titles",
"theme",
"font",
"locale",
"sections",
"promo_code",
"products",
"categories",
"occurrence_id"
]
}
},
"required": [
"name",
"type"
],
"title": "UpsertEventWidgetRequest"
},
"UpsertLocationRequest": {
"type": "object",
"properties": {
"name": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"structured_address": {
"type": "object",
"properties": {
"venue_name": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"address_line_1": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"address_line_2": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"city": {
"type": [
"string",
"null"
],
"maxLength": 85
},
"state_or_region": {
"type": [
"string",
"null"
],
"maxLength": 85
},
"zip_or_postal_code": {
"type": [
"string",
"null"
],
"maxLength": 85
},
"country": {
"type": [
"string",
"null"
],
"minLength": 2,
"maxLength": 2
}
}
},
"latitude": {
"type": [
"number",
"null"
],
"minimum": -90,
"maximum": 90
},
"longitude": {
"type": [
"number",
"null"
],
"minimum": -180,
"maximum": 180
},
"provider": {
"type": [
"string",
"null"
],
"enum": [
"google",
null
]
},
"provider_place_id": {
"type": [
"string",
"null"
],
"maxLength": 255
}
},
"required": [
"structured_address"
],
"title": "UpsertLocationRequest"
},
"UpsertOrganizerRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 100
},
"email": {
"type": "string",
"format": "email"
},
"phone": {
"type": [
"string",
"null"
],
"maxLength": 25
},
"website": {
"type": [
"string",
"null"
],
"format": "uri",
"maxLength": 255
},
"description": {
"type": [
"string",
"null"
],
"maxLength": 1200
},
"timezone": {
"type": "string"
},
"currency": {
"type": "string",
"enum": [
"AED",
"AFN",
"ALL",
"AMD",
"AOA",
"ARS",
"AUD",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BRL",
"BSD",
"BWP",
"BYN",
"BZD",
"CAD",
"CDF",
"CHF",
"CLP",
"CNY",
"COP",
"CRC",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"GBP",
"GEL",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HUF",
"IDR",
"ILS",
"INR",
"IQD",
"ISK",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MUR",
"MVR",
"MWK",
"MXN",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"STD",
"SVC",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"UYU",
"UZS",
"VND",
"VUV",
"WST",
"XCD",
"XAF",
"XOF",
"XPF",
"YER",
"ZAR",
"ZMW"
]
}
},
"required": [
"name",
"email",
"timezone",
"currency"
],
"title": "UpsertOrganizerRequest"
},
"UpsertOrganizerWidgetRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 100
},
"type": {
"type": "string",
"enum": [
"EVENTS"
]
},
"settings": {
"type": "object",
"properties": {
"background_color": {
"type": [
"string",
"null"
],
"pattern": "^#([0-9a-f]{3,4}|[0-9a-f]{6}|[0-9a-f]{8})$"
},
"primary_color": {
"type": [
"string",
"null"
],
"pattern": "^#([0-9a-f]{3,4}|[0-9a-f]{6}|[0-9a-f]{8})$"
},
"primary_text_color": {
"type": [
"string",
"null"
],
"pattern": "^#([0-9a-f]{3,4}|[0-9a-f]{6}|[0-9a-f]{8})$"
},
"secondary_color": {
"type": [
"string",
"null"
],
"pattern": "^#([0-9a-f]{3,4}|[0-9a-f]{6}|[0-9a-f]{8})$"
},
"secondary_text_color": {
"type": [
"string",
"null"
],
"pattern": "^#([0-9a-f]{3,4}|[0-9a-f]{6}|[0-9a-f]{8})$"
},
"padding": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 500
},
"radius": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 32
},
"continue_button_text": {
"type": [
"string",
"null"
],
"maxLength": 100
},
"button_text": {
"type": [
"string",
"null"
],
"maxLength": 100
},
"checkout": {
"type": [
"string",
"null"
],
"enum": [
"modal",
"new-tab",
null
]
},
"autoresize": {
"type": [
"boolean",
"null"
]
},
"show_lineup": {
"type": [
"boolean",
"null"
]
},
"hide_promo_code": {
"type": [
"boolean",
"null"
]
},
"hide_category_titles": {
"type": [
"boolean",
"null"
]
},
"theme": {
"type": [
"string",
"null"
],
"enum": [
"custom",
"event",
null
]
},
"font": {
"type": [
"string",
"null"
],
"enum": [
"Outfit",
"Inter",
"Roboto",
"Open Sans",
"Poppins",
"Montserrat",
"Lato",
"Nunito",
"Raleway",
"DM Sans",
"Plus Jakarta Sans",
"Work Sans",
"Space Grotesk",
"Manrope",
"Oswald",
"Bebas Neue",
"Playfair Display",
"Merriweather",
"Lora",
null
]
},
"locale": {
"type": [
"string",
"null"
],
"enum": [
"en",
"de",
"fi",
"fr",
"it",
"nl",
"hu",
"es",
"pt",
"pt-br",
"zh-cn",
"se",
"zh-hk",
"vi",
"tr",
"pl",
"sk",
"el",
"ko",
"ja",
null
]
},
"sections": {
"type": [
"array",
"null"
],
"items": {
"type": "string",
"enum": [
"tickets",
"header",
"about",
"location",
"organizer",
"lineup",
"schedule",
"custom"
]
},
"maxItems": 8
},
"promo_code": {
"type": [
"string",
"null"
],
"maxLength": 50
},
"products": {
"type": [
"array",
"null"
],
"items": {
"type": "integer",
"minimum": 1
},
"maxItems": 100
},
"categories": {
"type": [
"array",
"null"
],
"items": {
"type": "integer",
"minimum": 1
},
"maxItems": 100
},
"occurrence_id": {
"type": [
"integer",
"null"
],
"minimum": 1
},
"layout": {
"type": [
"string",
"null"
],
"enum": [
"list",
"grid",
"compact",
null
]
},
"limit": {
"type": [
"integer",
"null"
],
"minimum": 1,
"maximum": 50
},
"event_category": {
"type": [
"string",
"null"
],
"enum": [
"SOCIAL",
"FAMILY",
"HOBBIES",
"FOOD_DRINK",
"WELLNESS",
"SPIRITUALITY",
"OUTDOORS",
"TOURS",
"CHARITY",
"MUSIC",
"ART",
"COMEDY",
"THEATER",
"FILM",
"DANCE",
"BUSINESS",
"TECH",
"EDUCATION",
"WORKSHOP",
"SPORTS",
"FESTIVAL",
"SEASONAL",
"NIGHTLIFE",
"OTHER",
null
]
},
"show_past": {
"type": [
"boolean",
"null"
]
},
"open_in": {
"type": [
"string",
"null"
],
"enum": [
"popup",
"page",
null
]
}
},
"required": [
"background_color",
"primary_color",
"primary_text_color",
"secondary_color",
"secondary_text_color",
"padding",
"radius",
"continue_button_text",
"button_text",
"checkout",
"autoresize",
"show_lineup",
"hide_promo_code",
"hide_category_titles",
"theme",
"font",
"locale",
"sections",
"promo_code",
"products",
"categories",
"occurrence_id"
]
}
},
"required": [
"name",
"type"
],
"title": "UpsertOrganizerWidgetRequest"
},
"UpsertPriceOverrideRequest": {
"type": "object",
"properties": {
"product_price_id": {
"type": "integer"
},
"price": {
"type": [
"number",
"null"
],
"minimum": 0,
"maximum": 100000000
},
"quantity_available": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 2147483647
}
},
"required": [
"product_price_id"
],
"title": "UpsertPriceOverrideRequest"
},
"UpsertProductCategoryRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 50
},
"description": {
"type": [
"string",
"null"
],
"maxLength": 5000
},
"is_hidden": {
"type": "boolean"
},
"no_products_message": {
"type": [
"string",
"null"
],
"maxLength": 255
}
},
"required": [
"name",
"is_hidden"
],
"title": "UpsertProductCategoryRequest"
},
"UpsertProductRequest": {
"type": "object",
"properties": {
"title": {
"type": "string",
"maxLength": 255
},
"initial_quantity_available": {
"type": [
"integer",
"null"
],
"maximum": 2147483647
},
"quantity_sold": {
"type": "integer",
"maximum": 2147483647
},
"sale_start_date": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"sale_end_date": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"max_per_order": {
"type": [
"integer",
"null"
],
"maximum": 2147483647
},
"prices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"price": {
"type": "number",
"maximum": 999999999999
},
"label": {
"type": [
"string",
"null"
],
"minLength": 1,
"maxLength": 100
},
"sale_start_date": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"sale_end_date": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"initial_quantity_available": {
"type": [
"integer",
"null"
],
"minimum": 0,
"maximum": 2147483647
},
"is_hidden": {
"type": "boolean"
},
"quantity_applies_to": {
"type": [
"string",
"null"
],
"enum": [
"OCCURRENCE",
"EVENT",
null
]
}
},
"required": [
"price"
]
},
"minItems": 1
},
"description": {
"type": [
"string",
"null"
]
},
"min_per_order": {
"type": [
"integer",
"null"
],
"maximum": 2147483647
},
"is_hidden": {
"type": "boolean"
},
"hide_before_sale_start_date": {
"type": "boolean"
},
"hide_after_sale_end_date": {
"type": "boolean"
},
"hide_when_sold_out": {
"type": "boolean"
},
"sequential_tier_release_enabled": {
"type": "boolean"
},
"start_collapsed": {
"type": "boolean"
},
"show_quantity_remaining": {
"type": "boolean"
},
"is_hidden_without_promo_code": {
"type": "boolean"
},
"type": {
"type": "string",
"enum": [
"PAID",
"FREE",
"DONATION",
"TIERED",
"REGISTRATION"
]
},
"product_type": {
"type": "string",
"enum": [
"TICKET",
"GENERAL"
]
},
"tax_and_fee_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"addon_product_ids": {
"type": "array",
"items": {
"type": "integer"
}
},
"is_addon_only": {
"type": "boolean"
},
"product_category_id": {
"type": "integer"
},
"is_highlighted": {
"type": "boolean"
},
"highlight_message": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"waitlist_enabled": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"title",
"prices",
"type",
"product_type",
"product_category_id"
],
"title": "UpsertProductRequest"
},
"UpsertProfileRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 255
},
"tagline": {
"type": [
"string",
"null"
],
"maxLength": 255
},
"bio": {
"type": [
"string",
"null"
],
"maxLength": 20000
},
"links": {
"type": "array",
"items": {
"type": "string",
"format": "uri",
"maxLength": 500
},
"maxItems": 12
}
},
"required": [
"name"
],
"title": "UpsertProfileRequest"
},
"UpsertQuestionRequest": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
File truncated at 1 MB.