{ "openapi": "3.0.1", "info": { "title": "Brushfire API: Version 2025-07-22", "version": "2025-07-22", "description": "The Brushfire REST API provides programmatic access to the Brushfire event ticketing and registration platform. It covers events, ticket types, sections and seats, attendees, orders, the shopping cart and checkout flow, groups, sessions and check-in, promotions and access codes, payment profiles, and webhooks (Hooks). Authenticate by sending your App Key (requested at https://developer.brushfire.com/key) in the Authorization header. The API is date-versioned: send the desired version in the api-version request header (for example, 2025-07-22). This document is the live specification published at api.brushfire.com/swagger.", "contact": { "name": "Brushfire Developers", "url": "https://developer.brushfire.com" } }, "servers": [ { "url": "https://api.brushfire.com", "description": "Brushfire API (date-versioned via the api-version header)" } ], "paths": { "/accesscodes": { "get": { "tags": [ "AccessCodes" ], "summary": "List all access codes for a specific client (and additional parameters)", "parameters": [ { "name": "clientId", "in": "query", "description": "A string, a GUID, or an integer that corresponds to a specific client", "schema": { "type": "string" } }, { "name": "kind", "in": "query", "description": "An option string value from \"Standard\", \"Template\", or \"Dynamic\" that represents the kind of access code", "schema": { "$ref": "#/components/schemas/AccessCodeKind" } }, { "name": "isRedeemed", "in": "query", "description": "An optional boolean value if the access code has been redeemed", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "description": "An option string to filter access codes by name", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccessCodeOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccessCodeOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/accesscodes/{accessCodeId}": { "get": { "tags": [ "AccessCodes" ], "summary": "Get details of a single access code", "parameters": [ { "name": "accessCodeId", "in": "path", "description": "A GUID that corresponds to a specific access code", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessCodeOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccessCodeOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/accesscodes/dynamic": { "post": { "tags": [ "AccessCodes" ], "summary": "Creates the specified quantity of dynamic access codes based upon the provided template code", "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessCodeCreateInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccessCodeCreateInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AccessCodeCreateInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccessCodeCreateOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccessCodeCreateOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/accounts/{accountId}": { "get": { "tags": [ "Accounts" ], "summary": "Retrieve information for a specific account", "parameters": [ { "name": "accountId", "in": "path", "description": "An Email, a GUID, an Access Key, or an integer that corresponds to a specific account", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountSingleOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountSingleOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/accounts/auth": { "post": { "tags": [ "Accounts" ], "summary": "Authenticate a user via email and password or social service to get Access Key", "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountAuthInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountAuthInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AccountAuthInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountAuthOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountAuthOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/accounts/helpdesk/{email}": { "get": { "tags": [ "Accounts" ], "summary": "Retrieve an account that matches the provided email", "parameters": [ { "name": "email", "in": "path", "description": "An Email that corresponds to a specific account", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountHelpdeskOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountHelpdeskOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/attendees/{attendeeId}": { "get": { "tags": [ "Attendees" ], "summary": "Retrieve all relevant attendee information for the given attendee number", "parameters": [ { "name": "attendeeId", "in": "path", "description": "An integer, GUID, or a string that corresponds to a specific attendee", "required": true, "schema": { "type": "string" } }, { "name": "eventId", "in": "query", "description": "An integer or a GUID that corresponds to a specific event (only necessary if sending an attendee code)", "schema": { "type": "string" } }, { "name": "accessKey", "in": "query", "description": "The Access Key for the user context", "schema": { "type": "string" } }, { "name": "qrSize", "in": "query", "description": "The width and height of the QR Code. If blank, no QR will be sent.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttendeeDetailsOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AttendeeDetailsOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/attendees/{attendeeId}/cancel": { "post": { "tags": [ "Attendees" ], "summary": "Cancel an attendee (zero financial change only)", "parameters": [ { "name": "attendeeId", "in": "path", "description": "An integer or a GUID that corresponds to a specific attendee", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttendeeCancelInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AttendeeCancelInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AttendeeCancelInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderCreateOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderCreateOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/attendees/{attendeeId}/code": { "post": { "tags": [ "Attendees" ], "summary": "Associate an external code with a Brushfire attendee for scanning, etc.", "parameters": [ { "name": "attendeeId", "in": "path", "description": "An integer or a GUID that corresponds to a specific attendee", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttendeeCodeInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AttendeeCodeInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AttendeeCodeInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttendeeDetailsOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AttendeeDetailsOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/attendees/{attendeeId}/communities": { "get": { "tags": [ "Attendees" ], "summary": "Gets all the available communities for this specific attendee based upon any rules that might be in place", "parameters": [ { "name": "attendeeId", "in": "path", "description": "An integer or a GUID that corresponds to a specific attendee", "required": true, "schema": { "type": "string" } }, { "name": "accessKey", "in": "query", "description": "The Access Key for the user context", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AttendeeCommunityOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AttendeeCommunityOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/attendees/{attendeeId}/community": { "post": { "tags": [ "Attendees" ], "summary": "Set or clear the community for the specified attendee (as long as the group's community doesn't override)", "parameters": [ { "name": "attendeeId", "in": "path", "description": "An integer or a GUID that corresponds to a specific attendee", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttendeeCommunityInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AttendeeCommunityInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AttendeeCommunityInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttendeeDetailsOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AttendeeDetailsOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/attendees/{attendeeId}/completed": { "post": { "tags": [ "Attendees" ], "summary": "Set a registered attendee's completed state", "parameters": [ { "name": "attendeeId", "in": "path", "description": "An integer or a GUID that corresponds to a specific attendee", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttendeeCompletedInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AttendeeCompletedInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AttendeeCompletedInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttendeeDetailsOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AttendeeDetailsOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/attendees/{attendeeId}/data": { "get": { "tags": [ "Attendees" ], "summary": "Returns all data for the specified attendee in the same structure as {eventId}/data", "parameters": [ { "name": "attendeeId", "in": "path", "description": "An integer, GUID, or a string that corresponds to a specific attendee", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {} }, "text/json": { "schema": {} } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/attendees/{attendeeId}/donate": { "post": { "tags": [ "Attendees" ], "summary": "Donate back an attendee", "parameters": [ { "name": "attendeeId", "in": "path", "description": "An integer or a GUID that corresponds to a specific attendee", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttendeeDonateInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AttendeeDonateInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AttendeeDonateInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderCreateOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderCreateOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/attendees/{attendeeId}/fields": { "get": { "tags": [ "Attendees" ], "summary": "Retrieve fields for an attendee", "parameters": [ { "name": "attendeeId", "in": "path", "description": "An integer or a GUID that corresponds to a specific attendee", "required": true, "schema": { "type": "string" } }, { "name": "accessKey", "in": "query", "description": "The Access Key for the user context", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FieldOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FieldOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] }, "post": { "tags": [ "Attendees" ], "summary": "Update fields for an attendee", "parameters": [ { "name": "attendeeId", "in": "path", "description": "An integer or a GUID that corresponds to a specific attendee", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldUpdateInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FieldUpdateInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/FieldUpdateInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FieldOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FieldOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/attendees/{attendeeId}/fieldscustom": { "get": { "tags": [ "Attendees" ], "summary": "Retrieve fields for an attendee", "parameters": [ { "name": "attendeeId", "in": "path", "description": "An integer or a GUID that corresponds to a specific attendee", "required": true, "schema": { "type": "string" } }, { "name": "fieldsToInclude", "in": "query", "description": "The Id's of the fields you want returned", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "accessKey", "in": "query", "description": "The Access Key for the user context", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FieldOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FieldOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] }, "post": { "tags": [ "Attendees" ], "summary": "Update fields for an attendee", "parameters": [ { "name": "attendeeId", "in": "path", "description": "An integer or a GUID that corresponds to a specific attendee", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldUpdateInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FieldUpdateInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/FieldUpdateInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FieldOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FieldOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/attendees/{attendeeId}/gift": { "post": { "tags": [ "Attendees" ], "summary": "Set an attendee registration as a gift", "parameters": [ { "name": "attendeeId", "in": "path", "description": "An integer or a GUID that corresponds to a specific attendee", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttendeeUpdateGiftInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AttendeeUpdateGiftInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AttendeeUpdateGiftInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttendeeUpdateGiftOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AttendeeUpdateGiftOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/attendees/{attendeeId}/group": { "post": { "tags": [ "Attendees" ], "summary": "Set or clear the group (and the associated community) for the specified attendee", "parameters": [ { "name": "attendeeId", "in": "path", "description": "An integer or a GUID that corresponds to a specific attendee", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttendeeGroupInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AttendeeGroupInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AttendeeGroupInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttendeeDetailsOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AttendeeDetailsOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/attendees/{attendeeId}/link": { "post": { "tags": [ "Attendees" ], "summary": "Copy all fields from the source attendee to the specified attendee and link them together", "parameters": [ { "name": "attendeeId", "in": "path", "description": "An integer or a GUID that corresponds to a specific attendee", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttendeeLinkInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AttendeeLinkInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AttendeeLinkInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttendeeDetailsOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AttendeeDetailsOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/attendees/{attendeeId}/print": { "get": { "tags": [ "Attendees" ], "summary": "Retrieve the printable resources for a single attendee", "parameters": [ { "name": "attendeeId", "in": "path", "description": "An integer or a GUID that corresponds to a specific attendee", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "A string that is one of \"Ticket\", \"ETicket\", or \"Namebadge\"", "schema": { "$ref": "#/components/schemas/PrintType" } }, { "name": "format", "in": "query", "description": "A string that is one of \"PDF\", \"PNG\", \"JPG\", \"GIF\", \"BMP\" or \"TIFF\"", "schema": { "$ref": "#/components/schemas/PrintFormat" } }, { "name": "imageDpi", "in": "query", "description": "An int representing the dots per inch of the images produced that is 72, 96, 150, 300 or 600. 0 for PDF", "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/attendees/{attendeeId}/type": { "post": { "tags": [ "Attendees" ], "summary": "Change an attendee type (zero financial change only)", "parameters": [ { "name": "attendeeId", "in": "path", "description": "An integer or a GUID that corresponds to a specific attendee", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttendeeUpdateTypeInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AttendeeUpdateTypeInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AttendeeUpdateTypeInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderCreateOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderCreateOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/attendees/helpdesk/{email}": { "get": { "tags": [ "Attendees" ], "summary": "Retrieve attendees that match provided email", "parameters": [ { "name": "email", "in": "path", "description": "An email to search across attendee email fields", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AttendeeHelpdeskOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AttendeeHelpdeskOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/attendees/ids": { "post": { "tags": [ "Attendees" ], "summary": "Convert a list of attendee numbers to their corresponding unique IDs, checking permissions for each", "requestBody": { "description": "Object containing list of attendee numbers to convert", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttendeeNumbersToIdsInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AttendeeNumbersToIdsInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AttendeeNumbersToIdsInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttendeeNumbersToIdsOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AttendeeNumbersToIdsOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/attendees/print": { "post": { "tags": [ "Attendees" ], "summary": "Retrieve the printable resources for multiple attendees", "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttendeePrintInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AttendeePrintInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AttendeePrintInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/cart/{cartId}": { "get": { "tags": [ "Cart" ], "summary": "Retrieve events and attendees for a specific cart", "parameters": [ { "name": "cartId", "in": "path", "description": "A valid CartId that was previously generated by /cart/id", "required": true, "schema": { "type": "string" } }, { "name": "accessKey", "in": "query", "description": "The Access Key for the user context", "schema": { "type": "string" } }, { "name": "pos", "in": "query", "description": "A boolean indicating if this cart should be retrieved for POS mode", "schema": { "type": "boolean", "default": false } }, { "name": "exclude", "in": "query", "description": "A comma-separated list of GUIDs representing the ID of each promotion you would like to exclude from the cart", "schema": { "type": "string" } }, { "name": "slipstream", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "originalOrderId", "in": "query", "description": "A valid OrderId to ease adding other attendees and add-ons", "schema": { "type": "string" } }, { "name": "exchangeId", "in": "query", "description": "A valid ExchangeId to associate this cart with an exchange", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CartEventOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CartEventOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/cart/{cartId}/events/{eventId}": { "delete": { "tags": [ "Cart" ], "summary": "Delete all attendees for a specific event in a specific cart", "parameters": [ { "name": "cartId", "in": "path", "description": "A valid CartId that was previously generated by /cart/id", "required": true, "schema": { "type": "string" } }, { "name": "eventId", "in": "path", "description": "An integer or a GUID that corresponds to a specific event", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CartDeleteEventOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CartDeleteEventOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] }, "get": { "tags": [ "Cart" ], "summary": "Retrieve event and attendees for a specific cart and specific event", "parameters": [ { "name": "cartId", "in": "path", "description": "A valid CartId that was previously generated by /cart/id", "required": true, "schema": { "type": "string" } }, { "name": "eventId", "in": "path", "description": "An integer or a GUID that corresponds to a specific event", "required": true, "schema": { "type": "string" } }, { "name": "accessKey", "in": "query", "description": "The Access Key for the user context", "schema": { "type": "string" } }, { "name": "pos", "in": "query", "description": "A boolean indicating if this cart should be retrieved for POS mode", "schema": { "type": "boolean", "default": false } }, { "name": "exclude", "in": "query", "description": "A comma-separated list of GUIDs representing the ID of each promotion you would like to exclude from the cart", "schema": { "type": "string" } }, { "name": "slipstream", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "originalOrderId", "in": "query", "description": "A valid OrderId for a post-order add-on purchase", "schema": { "type": "string" } }, { "name": "exchangeId", "in": "query", "description": "A valid ExchangeId to associate this cart with an exchange", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CartEventOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CartEventOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] }, "post": { "tags": [ "Cart" ], "summary": "Update a specific event in a specific cart", "parameters": [ { "name": "cartId", "in": "path", "description": "A valid CartId that was previously generated by /cart/id", "required": true, "schema": { "type": "string" } }, { "name": "eventId", "in": "path", "description": "An integer or a GUID that corresponds to a specific event", "required": true, "schema": { "type": "string" } }, { "name": "originalOrderId", "in": "query", "description": "A valid OrderId for a post-order add-on purchase", "schema": { "type": "string" } }, { "name": "exchangeId", "in": "query", "description": "A valid ExchangeId to associate this cart with an exchange", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "Any options not provided will not be updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CartUpdateEventInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CartUpdateEventInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CartUpdateEventInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CartEventOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CartEventOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/cart/{cartId}/events/{eventId}/attendees": { "post": { "tags": [ "Cart" ], "summary": "Add attendees to the specified cart", "parameters": [ { "name": "cartId", "in": "path", "description": "A valid CartId that was previously generated by /cart/id", "required": true, "schema": { "type": "string" } }, { "name": "eventId", "in": "path", "description": "An integer or a GUID that corresponds to a specific event", "required": true, "schema": { "type": "string" } }, { "name": "originalOrderId", "in": "query", "description": "A valid OrderId for a post-order add-on purchase", "schema": { "type": "string" } }, { "name": "exchangeId", "in": "query", "description": "A valid ExchangeId to associate this cart with an exchange", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CartAddAttendeeInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CartAddAttendeeInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CartAddAttendeeInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CartAddAttendeeOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CartAddAttendeeOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/cart/{cartId}/events/{eventId}/attendees/{attendeeId}": { "delete": { "tags": [ "Cart" ], "summary": "Delete a specific attendee from a specific cart", "parameters": [ { "name": "cartId", "in": "path", "description": "A valid CartId that was previously generated by /cart/id", "required": true, "schema": { "type": "string" } }, { "name": "eventId", "in": "path", "description": "An integer or a GUID that corresponds to a specific event", "required": true, "schema": { "type": "string" } }, { "name": "attendeeId", "in": "path", "description": "An integer or a GUID that corresponds to a specific attendee", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CartDeleteAttendeeOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CartDeleteAttendeeOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] }, "get": { "tags": [ "Cart" ], "summary": "Retrieve information for a specific attendee in a specific cart", "parameters": [ { "name": "cartId", "in": "path", "description": "A valid CartId that was previously generated by /cart/id", "required": true, "schema": { "type": "string" } }, { "name": "eventId", "in": "path", "description": "An integer or a GUID that corresponds to a specific event", "required": true, "schema": { "type": "string" } }, { "name": "attendeeId", "in": "path", "description": "An integer or a GUID that corresponds to a specific attendee", "required": true, "schema": { "type": "string" } }, { "name": "originalOrderId", "in": "query", "description": "A valid OrderId for a post-order add-on purchase", "schema": { "type": "string" } }, { "name": "exchangeId", "in": "query", "description": "A valid ExchangeId to associate this cart with an exchange", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CartAttendeeOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CartAttendeeOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] }, "post": { "tags": [ "Cart" ], "summary": "Update information for a specific attendee in a specific cart", "parameters": [ { "name": "cartId", "in": "path", "description": "A valid CartId that was previously generated by /cart/id", "required": true, "schema": { "type": "string" } }, { "name": "eventId", "in": "path", "description": "An integer or a GUID that corresponds to a specific event", "required": true, "schema": { "type": "string" } }, { "name": "attendeeId", "in": "path", "description": "An integer or a GUID that corresponds to a specific attendee", "required": true, "schema": { "type": "string" } }, { "name": "originalOrderId", "in": "query", "description": "A valid OrderId for a post-order add-on purchase", "schema": { "type": "string" } }, { "name": "exchangeId", "in": "query", "description": "A valid ExchangeId to associate this cart with an exchange", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "Any options not provided will not be updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CartUpdateAttendeeInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CartUpdateAttendeeInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CartUpdateAttendeeInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CartAttendeeOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CartAttendeeOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/cart/{cartId}/events/{eventId}/attendees/{attendeeId}/form": { "get": { "tags": [ "Cart" ], "summary": "Retrieve form for a specific attendee for a specific event in a specific cart", "parameters": [ { "name": "cartId", "in": "path", "description": "A valid CartId that was previously generated by /cart/id", "required": true, "schema": { "type": "string" } }, { "name": "eventId", "in": "path", "description": "An integer or a GUID that corresponds to a specific event", "required": true, "schema": { "type": "string" } }, { "name": "attendeeId", "in": "path", "description": "An integer, GUID, or a string that corresponds to a specific attendee", "required": true, "schema": { "type": "string" } }, { "name": "accessKey", "in": "query", "description": "The Access Key for the user context", "schema": { "type": "string" } }, { "name": "originalOrderId", "in": "query", "description": "A valid OrderId for a post-order add-on purchase", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FormOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] }, "post": { "tags": [ "Cart" ], "summary": "Update form for a specific attendee for a specific event in a specific cart", "parameters": [ { "name": "cartId", "in": "path", "description": "A valid CartId that was previously generated by /cart/id", "required": true, "schema": { "type": "string" } }, { "name": "eventId", "in": "path", "description": "An integer or a GUID that corresponds to a specific event", "required": true, "schema": { "type": "string" } }, { "name": "attendeeId", "in": "path", "description": "An integer, GUID, or a string that corresponds to a specific attendee", "required": true, "schema": { "type": "string" } }, { "name": "originalOrderId", "in": "query", "description": "A valid OrderId for a post-order add-on purchase", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CartAttendeeFormInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CartAttendeeFormInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CartAttendeeFormInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FormOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/cart/{cartId}/events/{eventId}/form": { "get": { "tags": [ "Cart" ], "summary": "Retrieve form for the buyer for a specific event in a specific cart", "parameters": [ { "name": "cartId", "in": "path", "description": "A valid CartId that was previously generated by /cart/id", "required": true, "schema": { "type": "string" } }, { "name": "eventId", "in": "path", "description": "An integer or a GUID that corresponds to a specific event", "required": true, "schema": { "type": "string" } }, { "name": "accessKey", "in": "query", "description": "The Access Key for the user context", "schema": { "type": "string" } }, { "name": "originalOrderId", "in": "query", "description": "A valid OrderId for a post-order add-on purchase", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FormOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] }, "post": { "tags": [ "Cart" ], "summary": "Update form for the buyer for a specific event in a specific cart", "parameters": [ { "name": "cartId", "in": "path", "description": "A valid CartId that was previously generated by /cart/id", "required": true, "schema": { "type": "string" } }, { "name": "eventId", "in": "path", "description": "An integer or a GUID that corresponds to a specific event", "required": true, "schema": { "type": "string" } }, { "name": "originalOrderId", "in": "query", "description": "A valid OrderId for a post-order add-on purchase", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldUpdateInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FieldUpdateInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/FieldUpdateInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FormOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/cart/{cartId}/events/{eventId}/forms": { "get": { "tags": [ "Cart" ], "summary": "Retrieve forms for the buyer and attendees for a specific event in a specific cart", "parameters": [ { "name": "cartId", "in": "path", "description": "A valid CartId that was previously generated by /cart/id", "required": true, "schema": { "type": "string" } }, { "name": "eventId", "in": "path", "description": "An integer or a GUID that corresponds to a specific event", "required": true, "schema": { "type": "string" } }, { "name": "accessKey", "in": "query", "description": "The Access Key for the user context", "schema": { "type": "string" } }, { "name": "originalOrderId", "in": "query", "description": "A valid OrderId for a post-order add-on purchase", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FormOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FormOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/cart/{cartId}/lookup": { "get": { "tags": [ "Cart" ], "summary": "Search customer accounts and past orders for checkout information for specified cart", "parameters": [ { "name": "cartId", "in": "path", "description": "A valid CartId that was previously generated by /cart/{cartId}", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name you are searching for (first and/or last)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CartLookupOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CartLookupOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/cart/{cartId}/promotions": { "post": { "tags": [ "Cart" ], "summary": "Adds a promotion (by name) to a specific cart", "parameters": [ { "name": "cartId", "in": "path", "description": "A valid CartId that was previously generated by /cart/{cartId}", "required": true, "schema": { "type": "string" } }, { "name": "originalOrderId", "in": "query", "description": "A valid OrderId for a post-order add-on purchase", "schema": { "type": "string" } }, { "name": "exchangeId", "in": "query", "description": "A valid ExchangeId to associate this cart with an exchange", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CartAddPromotionInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CartAddPromotionInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CartAddPromotionInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CartPromotionOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CartPromotionOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/cart/{cartId}/promotions/{promotionId}": { "delete": { "tags": [ "Cart" ], "summary": "Delete a promotion from a specific cart", "parameters": [ { "name": "cartId", "in": "path", "description": "A valid CartId that was previously generated by /cart/{cartId}", "required": true, "schema": { "type": "string" } }, { "name": "promotionId", "in": "path", "description": "A GUID that corresponds to a specific promotion", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CartDeletePromotionOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CartDeletePromotionOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/cart/id": { "get": { "tags": [ "Cart" ], "summary": "Retreive a system-generated CartId for use in other calls", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CartIdOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CartIdOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/clients": { "get": { "tags": [ "Clients" ], "summary": "Get a list of all clients available to this application", "parameters": [ { "name": "accessKey", "in": "query", "description": "Optional Access Key for the user context", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClientListOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClientListOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/clients/{clientId}": { "get": { "tags": [ "Clients" ], "summary": "Get the details for a specific client", "parameters": [ { "name": "clientId", "in": "path", "description": "An string, a GUID, or an integer that corresponds to a specific client", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientSingleOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientSingleOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/clients/{clientId}/theme": { "get": { "tags": [ "Clients" ], "summary": "Get the theme for a specific client", "parameters": [ { "name": "clientId", "in": "path", "description": "A string, a GUID, or an integer that corresponds to a specific client", "required": true, "schema": { "type": "string" } }, { "name": "urlKey", "in": "query", "description": "An optional string that corresponds to a specific urlKey", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThemeOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ThemeOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/data/{id}": { "get": { "tags": [ "Data" ], "summary": "Returns specialized data from custom-written queries", "parameters": [ { "name": "id", "in": "path", "description": "The GUID for the query you are running", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "eventNumber", "in": "query", "description": "If present, an integer representing the event number", "schema": { "type": "integer", "format": "int64" } }, { "name": "granularity", "in": "query", "description": "If present, one of the following string values \"hour\", \"minute\", or \"day\"", "schema": { "$ref": "#/components/schemas/CustomQueryGranularity" } }, { "name": "startsAt", "in": "query", "description": "If present, the date/time in UTC to start data", "schema": { "type": "string", "format": "date-time" } }, { "name": "endsAt", "in": "query", "description": "If present, the date/time in UTC to end data", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {} }, "text/json": { "schema": {} } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/events": { "get": { "tags": [ "Events" ], "summary": "Get a list of events for the specified user.", "parameters": [ { "name": "accessKey", "in": "query", "description": "The Access Key for the user context", "schema": { "type": "string" } }, { "name": "search", "in": "query", "description": "A string to filter events", "schema": { "type": "string" } }, { "name": "inactive", "in": "query", "description": "Boolean pass in true to return inactive events.", "schema": { "type": "boolean", "default": false } }, { "name": "qty", "in": "query", "description": "An integer to limit the number of results returned", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "An integer to skip the first events returned", "schema": { "type": "integer", "format": "int32" } }, { "name": "archive", "in": "query", "description": "Boolean to return archived or not archvied events", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventListOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventListOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] }, "post": { "tags": [ "Events" ], "summary": "Create a fully complete event", "requestBody": { "description": "The request body to create an event", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventCreateInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EventCreateInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/EventCreateInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventDetailsOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EventDetailsOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/events/{eventId}": { "delete": { "tags": [ "Events" ], "summary": "Delete an event", "parameters": [ { "name": "accessKey", "in": "query", "description": "Access Key for user account", "schema": { "type": "string" } }, { "name": "eventId", "in": "path", "description": "An integer or a GUID that corresponds to the specific event you would like to delete", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] }, "get": { "tags": [ "Events" ], "summary": "Retrieve information for an event", "parameters": [ { "name": "eventId", "in": "path", "description": "An integer or a GUID that corresponds to a specific event", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventSingleOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EventSingleOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/events/{eventId}/archive": { "post": { "tags": [ "Events" ], "summary": "Queues the specified event for archiving. Sends an email to user associated with the access key used on completion.", "parameters": [ { "name": "eventId", "in": "path", "description": "An integer or a GUID that corresponds to a specific event", "required": true, "schema": { "type": "string" } }, { "name": "accessKey", "in": "query", "description": "The Access Key for the user context", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/events/{eventId}/bestseats": { "get": { "tags": [ "Events" ], "summary": "Returns the best available seats that match the supplied parameters for an assigned seat event. Does not reserve them.", "parameters": [ { "name": "eventId", "in": "path", "description": "An integer or a GUID that corresponds to a specific event", "required": true, "schema": { "type": "string" } }, { "name": "quantity", "in": "query", "description": "Integer to find a quantity of seats", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "sectionId", "in": "query", "description": "An optional string (the exact name) or a GUID representing the section", "schema": { "type": "string" } }, { "name": "accessKey", "in": "query", "description": "The Access Key for the user context", "schema": { "type": "string" } }, { "name": "typeId", "in": "query", "description": "Optional GUID to find seats in a particular type", "schema": { "type": "string", "format": "uuid" } }, { "name": "groupId", "in": "query", "description": "An optional integer or a GUID that corresponds to a specific group", "schema": { "type": "string" } }, { "name": "seatCode", "in": "query", "description": "An optional seat-level access code to unlock seats", "schema": { "type": "string" } }, { "name": "nonconsecutive", "in": "query", "description": "Optional boolean to find seats that are non-consecutive", "schema": { "type": "boolean", "default": false } }, { "name": "basePrice", "in": "query", "description": "Optional decimal to find seats in a particular base price", "schema": { "type": "number", "format": "double" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventSeatOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventSeatOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/events/{eventId}/communities": { "get": { "tags": [ "Events" ], "summary": "Returns all communities for the specified event", "parameters": [ { "name": "eventId", "in": "path", "description": "An integer or a GUID that corresponds to a specific event", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventCommunityOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventCommunityOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/events/{eventId}/data": { "get": { "tags": [ "Events" ], "summary": "Returns all data for the specified type", "parameters": [ { "name": "eventId", "in": "path", "description": "An integer or a GUID that corresponds to a specific event", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "A string value of \"Attendee\", \"Order\", or \"Group\"", "schema": { "$ref": "#/components/schemas/FieldMetaType" } }, { "name": "since", "in": "query", "description": "An optional date (UTC) from which to filter data", "schema": { "type": "string", "format": "date-time" } }, { "name": "includeCancelled", "in": "query", "description": "An optional boolean (default false) to include cancelled attendees", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {} }, "text/json": { "schema": {} } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/events/{eventId}/details": { "get": { "tags": [ "Events" ], "summary": "Retrieve information for an event", "parameters": [ { "name": "eventId", "in": "path", "description": "An integer or a GUID that corresponds to a specific event", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "query", "description": "An integer or a GUID that corresponds to a specific group", "schema": { "type": "string" } }, { "name": "accessKey", "in": "query", "description": "The Access Key for the user context", "schema": { "type": "string" } }, { "name": "access", "in": "query", "description": "The Access Code for accessing the event", "schema": { "type": "string" } }, { "name": "exchangeId", "in": "query", "description": "An optional exchange ID if currently exchanging", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventDetailsOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EventDetailsOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/events/{eventId}/documents": { "get": { "tags": [ "Events" ], "summary": "Get which printing layouts are available for an event", "parameters": [ { "name": "eventId", "in": "path", "description": "An integer or a GUID that corresponds to a specific event", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventDocumentOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EventDocumentOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/events/{eventId}/fieldmetadata": { "get": { "tags": [ "Events" ], "summary": "Get the meta data for ALL fields for an event including the built-in/system ones", "parameters": [ { "name": "eventId", "in": "path", "description": "An integer or a GUID that corresponds to a specific event", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FieldMetaOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FieldMetaOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/events/{eventId}/fields": { "get": { "tags": [ "Events" ], "summary": "Get fields for an event", "parameters": [ { "name": "eventId", "in": "path", "description": "An integer or a GUID that corresponds to a specific event", "required": true, "schema": { "type": "string" } }, { "name": "fieldType", "in": "query", "description": "One of \"Attendees\", \"Groups\", or \"Buyers\" for the type of fields you want", "schema": { "$ref": "#/components/schemas/FieldUpdateType" } }, { "name": "accessKey", "in": "query", "description": "The Access Key for the user context", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FieldOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FieldOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/events/{eventId}/fields/{fieldId}/remotevalidate": { "get": { "tags": [ "Events" ], "summary": "Fetch result for given Remote Valid field when value is provided", "parameters": [ { "name": "eventNumber", "in": "query", "description": "An integer that corresponds to a specific event", "schema": { "type": "integer", "format": "int64" } }, { "name": "fieldId", "in": "path", "description": "A GUID of the Remote Fetch field", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "value", "in": "query", "description": "The string of the value currently used in the attendee's search field. Required.", "schema": { "type": "string" } }, { "name": "attendeeNumber", "in": "query", "description": "The attendee number for the current attendee. Only applied to attendee fields", "schema": { "type": "integer", "format": "int64" } }, { "name": "eventId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/events/{eventId}/groups": { "get": { "tags": [ "Events" ], "summary": "List all groups for an event", "parameters": [ { "name": "eventId", "in": "path", "description": "An integer or a GUID that corresponds to a specific event", "required": true, "schema": { "type": "string" } }, { "name": "search", "in": "query", "description": "A string to filter groups", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupSummaryOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupSummaryOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/events/{eventId}/lookup": { "get": { "tags": [ "Events" ], "summary": "Look up attendees based upon email for an event", "parameters": [ { "name": "eventId", "in": "path", "description": "An integer or a GUID that corresponds to a specific event", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "The email of the attendee, buyer, or group manager", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LookupAttendeeResultOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LookupAttendeeResultOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/events/{eventId}/move": { "post": { "tags": [ "Events" ], "summary": "Move an event to a different client. The event must have no existing orders or emails.\r\nThe calling app must have access to both the source and target clients.", "parameters": [ { "name": "eventId", "in": "path", "description": "An integer or a GUID that corresponds to the specific event you would like to move", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request body for moving an event to a different client", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventMoveInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EventMoveInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/EventMoveInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventSingleOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EventSingleOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/events/{eventId}/orders": { "get": { "tags": [ "Events" ], "summary": "Gets list of orders for an event with an optional date range.", "parameters": [ { "name": "eventId", "in": "path", "description": "An integer or a GUID that corresponds to a specific event.", "required": true, "schema": { "type": "string" } }, { "name": "startsAt", "in": "query", "description": "Optional start date to filter list", "schema": { "type": "string", "format": "date-time" } }, { "name": "endsAt", "in": "query", "description": "Optional end date to filter list", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderListOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderListOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/events/{eventId}/paymentmethods": { "get": { "tags": [ "Events" ], "summary": "Get which payment methods are available for an event", "parameters": [ { "name": "eventId", "in": "path", "description": "An integer or a GUID that corresponds to a specific event", "required": true, "schema": { "type": "string" } }, { "name": "accessKey", "in": "query", "description": "The Access Key for the user context", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventPaymentMethodOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventPaymentMethodOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/events/{eventId}/reports/{reportId}": { "get": { "tags": [ "Events" ], "summary": "Get report data for a custom or preset event report", "parameters": [ { "name": "eventId", "in": "path", "description": "An integer or a GUID that corresponds to a specific event", "required": true, "schema": { "type": "string" } }, { "name": "reportId", "in": "path", "description": "A GUID that corresponds to a specific report or a string that corresponds to a specific report preset", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {} }, "text/json": { "schema": {} } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/events/{eventId}/resources": { "get": { "tags": [ "Events" ], "summary": "Get a list of resource urls corresponding to specific Brushfire pages for the event", "parameters": [ { "name": "eventId", "in": "path", "description": "An integer or a GUID that corresponds to a specific event", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventResourceOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventResourceOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/events/{eventId}/restore": { "post": { "tags": [ "Events" ], "summary": "Queues the specified event for restoring. Sends an email to user associated with the access key used on completion.", "parameters": [ { "name": "eventId", "in": "path", "description": "An integer or a GUID that corresponds to a specific event", "required": true, "schema": { "type": "string" } }, { "name": "accessKey", "in": "query", "description": "The Access Key for the user context", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/events/{eventId}/sections": { "get": { "tags": [ "Events" ], "summary": "Get the details for all the sections of an event", "parameters": [ { "name": "eventId", "in": "path", "description": "An integer or a GUID that corresponds to a specific event", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "query", "description": "An integer or a GUID that corresponds to a specific group", "schema": { "type": "string" } }, { "name": "seatCode", "in": "query", "description": "A seat-level access code to unlock seats", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventSectionOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventSectionOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/events/{eventId}/sections/{sectionId}": { "get": { "tags": [ "Events" ], "summary": "Get the details for a specific section", "parameters": [ { "name": "eventId", "in": "path", "description": "An integer or a GUID that corresponds to a specific event", "required": true, "schema": { "type": "string" } }, { "name": "sectionId", "in": "path", "description": "A string (the exact name) or a GUID representing the section", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "query", "description": "An integer or a GUID that corresponds to a specific group", "schema": { "type": "string" } }, { "name": "seatCode", "in": "query", "description": "A seat-level access code to unlock seats", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventSectionOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EventSectionOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/events/{eventId}/sections/{sectionId}/seats": { "get": { "tags": [ "Events" ], "summary": "Get all the seats in a section for a specific event", "parameters": [ { "name": "eventId", "in": "path", "description": "An integer or a GUID that corresponds to a specific event", "required": true, "schema": { "type": "string" } }, { "name": "sectionId", "in": "path", "description": "A string (the exact name) or a GUID representing the section", "required": true, "schema": { "type": "string" } }, { "name": "groupId", "in": "query", "description": "An integer or a GUID that corresponds to a specific group", "schema": { "type": "string" } }, { "name": "seatCode", "in": "query", "description": "A seat-level access code to unlock seats", "schema": { "type": "string" } }, { "name": "accessKey", "in": "query", "description": "The Access Key for the user context", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventSeatOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventSeatOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/events/{eventId}/sessions": { "get": { "tags": [ "Events" ], "summary": "Get a list of all of the sessions for an event", "parameters": [ { "name": "eventId", "in": "path", "description": "An integer or a GUID that corresponds to a specific event", "required": true, "schema": { "type": "string" } }, { "name": "search", "in": "query", "description": "A string to filter sessions", "schema": { "type": "string" } }, { "name": "includeHidden", "in": "query", "description": "Show hidden sessions", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventSessionOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventSessionOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/events/{eventId}/theme": { "get": { "tags": [ "Events" ], "summary": "Get the theme for a specific event", "parameters": [ { "name": "eventId", "in": "path", "description": "A string, a GUID, or an integer that corresponds to a specific event", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThemeOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ThemeOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/events/{eventId}/types": { "get": { "tags": [ "Events" ], "summary": "List all currently available attendee types for a specific event and account (and optionally a specific seat)", "parameters": [ { "name": "eventId", "in": "path", "description": "An integer or a GUID that corresponds to a specific event", "required": true, "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "An integer or a GUID that corresponds to a specific group", "schema": { "type": "string" } }, { "name": "accessKey", "in": "query", "description": "Access Key for user account", "schema": { "type": "string" } }, { "name": "access", "in": "query", "description": "The Access Code for accessing the types", "schema": { "type": "string" } }, { "name": "seat", "in": "query", "description": "A GUID that corresponds to a specific seat, if blank, will return all types for the event", "schema": { "type": "string", "format": "uuid" } }, { "name": "category", "in": "query", "description": "A string value of \"All\", \"Standard\", or \"Addon\" which determines which type of Attendee Type will be returned. The default is \"Standard\" which returns only Standard types.", "schema": { "$ref": "#/components/schemas/AttendeeTypeCategory" } }, { "name": "exchangeId", "in": "query", "description": "An optional exchange ID if currently exchanging", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventTypeOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EventTypeOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/events/{eventNumber}/fields/{fieldId}/remotefetch": { "get": { "tags": [ "Events" ], "summary": "Fetch options for given Remote Fetch field when searching a specified value", "parameters": [ { "name": "eventNumber", "in": "path", "description": "An integer that corresponds to a specific event", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fieldId", "in": "path", "description": "A GUID of the Remote Fetch field", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "attendeeNumber", "in": "query", "description": "The attendee number for the current attendee. Only applied to attendee fields", "schema": { "type": "integer", "format": "int64" } }, { "name": "value", "in": "query", "description": "The string of the value currently used in the attendee's search field", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteFetchResult" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RemoteFetchResult" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/events/copy": { "post": { "tags": [ "Events" ], "summary": "Copy an existing event", "requestBody": { "description": "Request body for copying an event. Leave fields empty if you would like to use the source event's values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventCopyInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EventCopyInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/EventCopyInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventSingleOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EventSingleOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/exchanges": { "post": { "tags": [ "Exchanges" ], "summary": "Create an exchange", "requestBody": { "description": "Exchange create body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExchangeInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExchangeInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ExchangeInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExchangeOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExchangeOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/exchanges/{exchangeId}": { "delete": { "tags": [ "Exchanges" ], "summary": "Deletes an exchange based on the provided exchange ID and client key.", "parameters": [ { "name": "exchangeId", "in": "path", "description": "A valid ExchangeId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] }, "get": { "tags": [ "Exchanges" ], "summary": "Get full details of an exchange", "parameters": [ { "name": "exchangeId", "in": "path", "description": "A valid ExchangeId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExchangeOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExchangeOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] }, "put": { "tags": [ "Exchanges" ], "summary": "Update an exchange", "parameters": [ { "name": "exchangeId", "in": "path", "description": "A valid ExchangeId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Exchange update body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExchangeInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExchangeInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ExchangeInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExchangeOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExchangeOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/groups": { "post": { "tags": [ "Groups" ], "summary": "Create a group", "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupCreateInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GroupCreateInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/GroupCreateInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupCreateOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GroupCreateOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] }, "put": { "tags": [ "Groups" ], "summary": "Update a group", "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupUpdateInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GroupUpdateInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/GroupUpdateInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupCreateOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GroupCreateOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/groups/{groupId}": { "get": { "tags": [ "Groups" ], "summary": "Retrieve information about a group", "parameters": [ { "name": "groupId", "in": "path", "description": "A GUID or an integer representing a group", "required": true, "schema": { "type": "string" } }, { "name": "accessKey", "in": "query", "description": "The Access Key for the user context", "schema": { "type": "string" } }, { "name": "qrSize", "in": "query", "description": "The width and height of the QR Code. If blank, no QR will be sent.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupSingleOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GroupSingleOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/groups/{groupId}/community": { "post": { "tags": [ "Groups" ], "summary": "Set or clear the community for the specified group and all of its attendees", "parameters": [ { "name": "groupId", "in": "path", "description": "A GUID or an integer representing a group", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupCommunityInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GroupCommunityInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/GroupCommunityInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupCreateOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GroupCreateOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/groups/{groupId}/fields": { "get": { "tags": [ "Groups" ], "summary": "Retrieve fields for a group", "parameters": [ { "name": "groupId", "in": "path", "description": "A GUID or an integer representing a group", "required": true, "schema": { "type": "string" } }, { "name": "accessKey", "in": "query", "description": "The Access Key for the user context", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FieldOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FieldOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] }, "post": { "tags": [ "Groups" ], "summary": "Update fields for a group", "parameters": [ { "name": "groupId", "in": "path", "description": "A GUID or an integer representing a group", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldUpdateInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FieldUpdateInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/FieldUpdateInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FieldOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FieldOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/groups/{groupId}/print": { "get": { "tags": [ "Groups" ], "summary": "Retrieve the printable resources for a single group", "parameters": [ { "name": "groupId", "in": "path", "description": "A GUID or an integer representing a group", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "A string that is one of \"Ticket\", \"ETicket\", or \"Namebadge\"", "schema": { "$ref": "#/components/schemas/PrintType" } }, { "name": "format", "in": "query", "description": "A string that is one of \"PDF\", \"PNG\", \"JPG\", \"GIF\", \"BMP\" or \"TIFF\"", "schema": { "$ref": "#/components/schemas/PrintFormat" } }, { "name": "imageDpi", "in": "query", "description": "An int representing the dots per inch of the images produced that is 72, 96, 150, 300 or 600. 0 for PDF", "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/groups/helpdesk/{email}": { "get": { "tags": [ "Groups" ], "summary": "Retrieve groups that match provided email", "parameters": [ { "name": "email", "in": "path", "description": "An email to search across group email fields", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupHelpdeskOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GroupHelpdeskOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/groups/print": { "post": { "tags": [ "Groups" ], "summary": "Retrieve the printable resources for multiple groups", "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupPrintInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GroupPrintInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/GroupPrintInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/hooks/list": { "get": { "tags": [ "Hooks" ], "summary": "For 3rd party and custom integrations to list hooks subscribed by appKey", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HookSubscribeOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HookSubscribeOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/hooks/ping": { "get": { "tags": [ "Hooks" ], "summary": "For 3rd party and custom integrations to test connectivity after authentication", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": {} } }, "text/json": { "schema": { "type": "array", "items": {} } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/hooks/poll": { "get": { "tags": [ "Hooks" ], "summary": "For 3rd party and custom integrations to view shape for `data` property of POST from Brushfire", "parameters": [ { "name": "type", "in": "query", "description": "", "schema": { "$ref": "#/components/schemas/WebhookType" } }, { "name": "eventId", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/hooks/sample": { "get": { "tags": [ "Hooks" ], "summary": "For 3rd party and custom integrations to view shape for `data` property of POST from Brushfire", "parameters": [ { "name": "type", "in": "query", "description": "", "schema": { "$ref": "#/components/schemas/WebhookType" } }, { "name": "eventId", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/hooks/subscribe": { "post": { "tags": [ "Hooks" ], "summary": "For 3rd party and custom integrations to subscribe to our notifications", "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HookSubscribeInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HookSubscribeInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/HookSubscribeInput" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/hooks/unsubscribe": { "post": { "tags": [ "Hooks" ], "summary": "For 3rd party and custom integrations to unsubscribe from our notifications", "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HookUnsubscribeInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HookUnsubscribeInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/HookUnsubscribeInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/hooks/update": { "put": { "tags": [ "Hooks" ], "summary": "For 3rd party and custom integrations to update objects on existing subscriptions", "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HookUpdateInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HookUpdateInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/HookUpdateInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HookSubscribeOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HookSubscribeOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/lookups": { "post": { "tags": [ "Lookups" ], "summary": "Submit email to look up and create magic link", "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LookupCreateInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LookupCreateInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/LookupCreateInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/lookups/{lookupId}": { "get": { "tags": [ "Lookups" ], "summary": "Get matching events for a lookup ID", "parameters": [ { "name": "lookupId", "in": "path", "description": "A Guid retrieved from performing a post to /", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LookupResultOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LookupResultOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/lookups/{lookupId}/events/{eventNumber}": { "get": { "tags": [ "Lookups" ], "summary": "Get matching single event for a lookup ID and eventNumber", "parameters": [ { "name": "lookupId", "in": "path", "description": "A Guid retrieved from performing a post to /", "required": true, "schema": { "type": "string" } }, { "name": "eventNumber", "in": "path", "description": "An integer representing a single event", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LookupResultOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LookupResultOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/lookups/{lookupId}/events/{eventNumber}/attendees": { "get": { "tags": [ "Lookups" ], "summary": "Get attendees for the selected lookup ID and eventNumber. This optionally looks across groups and orders also", "parameters": [ { "name": "lookupId", "in": "path", "description": "A Guid retrieved from performing a post to /", "required": true, "schema": { "type": "string" } }, { "name": "eventNumber", "in": "path", "description": "An integer representing a single event", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "includeGroups", "in": "query", "description": "Boolean to include group emails in search. Defaults to false.", "schema": { "type": "boolean", "default": false } }, { "name": "includeOrders", "in": "query", "description": "Boolean to include buyer emails in search. Defaults to false.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LookupAttendeeResultOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LookupAttendeeResultOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/lookups/{lookupId}/events/{eventNumber}/group": { "get": { "tags": [ "Lookups" ], "summary": "Get group for the selected lookup ID and eventNumber", "parameters": [ { "name": "lookupId", "in": "path", "description": "A Guid retrieved from performing a post to /", "required": true, "schema": { "type": "string" } }, { "name": "eventNumber", "in": "path", "description": "An integer representing a single event", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LookupGroupResultOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LookupGroupResultOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/lookups/{lookupId}/events/{eventNumber}/orders": { "get": { "tags": [ "Lookups" ], "summary": "Get orders for the selected lookup ID and eventNumber", "parameters": [ { "name": "lookupId", "in": "path", "description": "A Guid retrieved from performing a post to /", "required": true, "schema": { "type": "string" } }, { "name": "eventNumber", "in": "path", "description": "An integer representing a single event", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LookupOrderResultOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LookupOrderResultOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/orders": { "get": { "tags": [ "Orders" ], "summary": "Gets list of orders by eventId and/or a date range.", "parameters": [ { "name": "eventId", "in": "query", "description": "An integer or a GUID that corresponds to a specific event. Only required if there is no startsAt or endsAt.", "schema": { "type": "string" } }, { "name": "startsAt", "in": "query", "description": "Optional start date to filter list", "schema": { "type": "string", "format": "date-time" } }, { "name": "endsAt", "in": "query", "description": "Optional end date to filter list", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderListOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderListOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] }, "post": { "tags": [ "Orders" ], "summary": "Create an order from an existing cart", "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderCreateInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderCreateInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/OrderCreateInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderCreateOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderCreateOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/orders/{orderId}": { "get": { "tags": [ "Orders" ], "summary": "Retrieve a single order", "parameters": [ { "name": "orderId", "in": "path", "description": "A string (orderKey) or a GUID representing a specific order", "required": true, "schema": { "type": "string" } }, { "name": "accessKey", "in": "query", "description": "The Access Key for the user context", "schema": { "type": "string" } }, { "name": "qrSize", "in": "query", "description": "The width and height of the QR Code. If blank, no QR will be sent.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderSingleOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderSingleOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/orders/{orderId}/fields": { "get": { "tags": [ "Orders" ], "summary": "Retrieve fields for an order", "parameters": [ { "name": "orderId", "in": "path", "description": "A string (orderKey) or a GUID representing a specific order", "required": true, "schema": { "type": "string" } }, { "name": "accessKey", "in": "query", "description": "The Access Key for the user context", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FieldOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FieldOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] }, "post": { "tags": [ "Orders" ], "summary": "Update fields for an order", "parameters": [ { "name": "orderId", "in": "path", "description": "A string (orderKey) or a GUID representing a specific order", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldUpdateInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FieldUpdateInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/FieldUpdateInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FieldOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FieldOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/orders/{orderId}/print": { "get": { "tags": [ "Orders" ], "summary": "Retrieve the printable resources for a single order", "parameters": [ { "name": "orderId", "in": "path", "description": "A string (orderKey) or a GUID representing a specific order", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "A string that is one of \"Ticket\", \"ETicket\", or \"Namebadge\"", "schema": { "$ref": "#/components/schemas/PrintType" } }, { "name": "format", "in": "query", "description": "A string that is one of \"PDF\", \"PNG\", \"JPG\", \"GIF\", \"BMP\" or \"TIFF\"", "schema": { "$ref": "#/components/schemas/PrintFormat" } }, { "name": "imageDpi", "in": "query", "description": "An int representing the dots per inch of the images produced that is 72, 96, 150, 300 or 600. 0 for PDF", "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/orders/{orderId}/resend": { "post": { "tags": [ "Orders" ], "summary": "Resend a confirmation for a single order", "parameters": [ { "name": "orderId", "in": "path", "description": "A string (orderKey) or a GUID representing a specific order", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Contains optional access key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderConfirmationResendInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderConfirmationResendInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/OrderConfirmationResendInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/orders/direct": { "post": { "tags": [ "Orders" ], "summary": "Create cart-less order for free, general admission events with no fields.", "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderCreateDirectInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderCreateDirectInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/OrderCreateDirectInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderResultOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderResultOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/orders/helpdesk/{email}": { "get": { "tags": [ "Orders" ], "summary": "Retrieve orders that match provided email", "parameters": [ { "name": "email", "in": "path", "description": "An email to search across order email fields", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderHelpdeskOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderHelpdeskOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/orders/pos": { "post": { "tags": [ "Orders" ], "summary": "Create a point of sale order from an existing cart", "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderCreatePOSInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderCreatePOSInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/OrderCreatePOSInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderCreateOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderCreateOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/orders/print": { "post": { "tags": [ "Orders" ], "summary": "Retrieve the printable resources for multiple orders", "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderPrintInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderPrintInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/OrderPrintInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string", "format": "byte" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/orders/reader/start": { "post": { "tags": [ "Orders" ], "summary": "Prepares an order to be paid for with a Square or Stripe Reader.", "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderReaderStartInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderReaderStartInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/OrderReaderStartInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderReaderStartOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderReaderStartOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/orders/sms": { "post": { "tags": [ "Orders" ], "summary": "Sends SMS messages to the provided phone number (only US and Canada)", "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderSmsInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OrderSmsInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/OrderSmsInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/paymentprofiles": { "get": { "tags": [ "PaymentProfiles" ], "summary": "Returns all payment profiles for the specified client", "parameters": [ { "name": "clientId", "in": "query", "description": "A string, a GUID, or an integer that corresponds to a specific client", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentProfileListOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentProfileListOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/paymentprofiles/{paymentProfileId}": { "get": { "tags": [ "PaymentProfiles" ], "summary": "Returns the details of the specified payment profile", "parameters": [ { "name": "paymentProfileId", "in": "path", "description": "A GUID that corresponds to a specific payment profile", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentProfileSingleOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaymentProfileSingleOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/paymentprofiles/{paymentProfileId}/locations": { "get": { "tags": [ "PaymentProfiles" ], "summary": "Returns the locations associated with the merchant ID of a given payment profile.", "parameters": [ { "name": "paymentProfileId", "in": "path", "description": "A GUID that corresponds to a specific payment profile", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LocationSingleOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LocationSingleOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/paymentprofiles/{paymentProfileId}/terminals": { "get": { "tags": [ "PaymentProfiles" ], "summary": "Returns all terminals registered to the account associated with the supplied payment profile", "parameters": [ { "name": "paymentProfileId", "in": "path", "description": "A GUID that corresponds to a specific payment profile", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TerminalOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TerminalOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] }, "post": { "tags": [ "PaymentProfiles" ], "summary": "Add a terminal to the supplied payment profile", "parameters": [ { "name": "paymentProfileId", "in": "path", "description": "A GUID that corresponds to a specific payment profile", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TerminalCreateInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TerminalCreateInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TerminalCreateInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TerminalCreateOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TerminalCreateOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/promotions": { "get": { "tags": [ "Promotions" ], "summary": "List all promotions for a specific client (and additional parameters)", "parameters": [ { "name": "clientId", "in": "query", "description": "A string, a GUID, or an integer that corresponds to a specific client", "schema": { "type": "string" } }, { "name": "kind", "in": "query", "description": "An option string value from \"Standard\", \"Template\", or \"Dynamic\" that represents the kind of promotion", "schema": { "$ref": "#/components/schemas/PromotionKind" } }, { "name": "isRedeemed", "in": "query", "description": "An optional boolean value if the promotion has been redeemed", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "description": "An option string to filter promotion codes by name", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionListOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionListOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/promotions/{promotionId}": { "get": { "tags": [ "Promotions" ], "summary": "Get details of a single promotion", "parameters": [ { "name": "promotionId", "in": "path", "description": "A GUID that corresponds to a specific promotion", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromotionSingleOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PromotionSingleOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/promotions/dynamic": { "post": { "tags": [ "Promotions" ], "summary": "Creates the specified quantity of dynamic promotions based upon the provided template code", "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromotionCreateInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PromotionCreateInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PromotionCreateInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionCreateOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionCreateOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/promotions/import": { "post": { "tags": [ "Promotions" ], "summary": "Support for promotion creation based upon provided list of names", "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromotionCreateImportInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PromotionCreateImportInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PromotionCreateImportInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionCreateOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionCreateOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/regions": { "get": { "tags": [ "Regions" ], "summary": "List all countries and regions with their Code for use in other calls", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RegionDetailOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RegionDetailOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/sessions/{sessionId}": { "get": { "tags": [ "Sessions" ], "summary": "Get detailed information about a given session", "parameters": [ { "name": "sessionId", "in": "path", "description": "An integer that corresponds to a specific session", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventSessionOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EventSessionOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/sessions/{sessionId}/attendees": { "get": { "tags": [ "Sessions" ], "summary": "Get a list of all of the attendees for a given check-in session", "parameters": [ { "name": "sessionId", "in": "path", "description": "The session number for which to retrieve attendees", "required": true, "schema": { "type": "string" } }, { "name": "search", "in": "query", "description": "An optional search string for filtering attendees", "schema": { "type": "string", "default": "" } }, { "name": "qty", "in": "query", "description": "An integer to limit the number of results returned", "schema": { "type": "integer", "format": "int32" } }, { "name": "skip", "in": "query", "description": "An integer to skip the first attendees returned", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionAttendeeListOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SessionAttendeeListOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/sessions/{sessionId}/checkin": { "post": { "tags": [ "Sessions" ], "summary": "Check in one or more attendees for a specific session", "parameters": [ { "name": "sessionId", "in": "path", "description": "An integer representing the session to check into", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionCheckinMultipleInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SessionCheckinMultipleInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SessionCheckinMultipleInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SessionCheckinMultipleOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SessionCheckinMultipleOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/sessions/{sessionId}/checkout": { "post": { "tags": [ "Sessions" ], "summary": "Check out one or more attendees for a specific session", "parameters": [ { "name": "sessionId", "in": "path", "description": "An integer representing the session to check out of", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionCheckoutMultipleInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SessionCheckoutMultipleInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SessionCheckoutMultipleInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SessionCheckoutMultipleOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SessionCheckoutMultipleOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/sessions/{sessionId}/email/{email}": { "get": { "tags": [ "Sessions" ], "summary": "Retrieve attendee data from a specific email and session", "parameters": [ { "name": "email", "in": "path", "description": "A string representing an email address", "required": true, "schema": { "type": "string" } }, { "name": "sessionId", "in": "path", "description": "An integer representing a specific session", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SessionAttendeeOutput" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SessionAttendeeOutput" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/sessions/{sessionId}/flex/{attendeeId}": { "get": { "tags": [ "Sessions" ], "summary": "Get detailed information about a given flex attendee in a specific session", "parameters": [ { "name": "sessionId", "in": "path", "description": "An integer that corresponds to a specific session", "required": true, "schema": { "type": "string" } }, { "name": "attendeeId", "in": "path", "description": "An integer that corresponds to a specific attendee", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttendeeDetailsOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AttendeeDetailsOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/sessions/{sessionId}/flex/checkin": { "post": { "tags": [ "Sessions" ], "summary": "Checkin a flex pass attendee for a specific session", "parameters": [ { "name": "sessionId", "in": "path", "description": "An integer representing the session to check into", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionFlexPassCheckinInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SessionFlexPassCheckinInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SessionFlexPassCheckinInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionFlexPassCheckinOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SessionFlexPassCheckinOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/sessions/{sessionId}/flex/checkout": { "post": { "tags": [ "Sessions" ], "summary": "Check out a flex pass attendee for a specific session", "parameters": [ { "name": "sessionId", "in": "path", "description": "An integer representing the session to check out of", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionFlexPassCheckoutInput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SessionFlexPassCheckoutInput" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SessionFlexPassCheckoutInput" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionFlexPassCheckoutOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SessionFlexPassCheckoutOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/sessions/{sessionId}/groups/{groupId}": { "get": { "tags": [ "Sessions" ], "summary": "Get all details, including checkin info for a group in a given session", "parameters": [ { "name": "groupId", "in": "path", "description": "An integer or GUID representing a specific group", "required": true, "schema": { "type": "string" } }, { "name": "sessionId", "in": "path", "description": "An integer representing a specific session", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionGroupDetailOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SessionGroupDetailOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } }, "/sessions/{sessionId}/orders/{orderId}": { "get": { "tags": [ "Sessions" ], "summary": "Retrieve Order and Buyer data from a specific order and session", "parameters": [ { "name": "orderId", "in": "path", "description": "A string (orderKey) or a GUID representing a specific order", "required": true, "schema": { "type": "string" } }, { "name": "sessionId", "in": "path", "description": "An integer representing a specific session", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionOrderDetailOutput" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SessionOrderDetailOutput" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApiModelError" } } } } }, "security": [ { "apiKey": [] } ] } } }, "components": { "schemas": { "AccessCodeCreateInput": { "required": [ "Prefix", "Quantity", "TemplateId" ], "type": "object", "properties": { "TemplateId": { "type": "string", "format": "uuid" }, "Quantity": { "maximum": 250, "minimum": 1, "type": "integer", "format": "int32" }, "Prefix": { "maxLength": 13, "minLength": 0, "type": "string" } }, "additionalProperties": false }, "AccessCodeCreateOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Description": { "type": "string", "nullable": true }, "StartsAt": { "type": "string", "format": "date-time", "nullable": true }, "EndsAt": { "type": "string", "format": "date-time", "nullable": true }, "Kind": { "type": "string", "nullable": true }, "IsSingleUse": { "type": "boolean" }, "IsRedeemed": { "type": "boolean" }, "Names": { "type": "array", "items": { "type": "string" }, "nullable": true }, "Events": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "AttendeeTypes": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "Seats": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "AccessCodeKind": { "enum": [ "Standard", "Template", "Dynamic" ], "type": "string" }, "AccessCodeOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Description": { "type": "string", "nullable": true }, "StartsAt": { "type": "string", "format": "date-time", "nullable": true }, "EndsAt": { "type": "string", "format": "date-time", "nullable": true }, "Kind": { "type": "string", "nullable": true }, "IsSingleUse": { "type": "boolean" }, "IsRedeemed": { "type": "boolean" }, "Names": { "type": "array", "items": { "type": "string" }, "nullable": true }, "Events": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "AttendeeTypes": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "Seats": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "AccountAuthInput": { "required": [ "Email", "Password" ], "type": "object", "properties": { "Email": { "minLength": 1, "type": "string" }, "Password": { "maxLength": 64, "minLength": 8, "type": "string" } }, "additionalProperties": false }, "AccountAuthOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "FirstName": { "type": "string", "nullable": true }, "LastName": { "type": "string", "nullable": true }, "Email": { "type": "string", "nullable": true }, "AccountNumber": { "type": "integer", "format": "int64" }, "AccessKey": { "type": "string", "nullable": true }, "IsUser": { "type": "boolean" }, "AvatarUrl": { "type": "string", "nullable": true }, "IsBrushfireStaff": { "type": "boolean" } }, "additionalProperties": false }, "AccountHelpdeskOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "AccountNumber": { "type": "integer", "format": "int64" }, "Email": { "type": "string", "nullable": true }, "FirstName": { "type": "string", "nullable": true }, "LastName": { "type": "string", "nullable": true }, "IsUser": { "type": "boolean" }, "ClientRoles": { "type": "array", "items": { "$ref": "#/components/schemas/AccountRoleOutput" }, "nullable": true } }, "additionalProperties": false }, "AccountRoleOutput": { "type": "object", "properties": { "ClientId": { "type": "string", "format": "uuid" }, "ClientKey": { "type": "string", "nullable": true }, "ClientNumber": { "type": "integer", "format": "int64" }, "ClientName": { "type": "string", "nullable": true }, "ClientCity": { "type": "string", "nullable": true }, "ClientRegion": { "type": "string", "nullable": true }, "ClientCountry": { "type": "string", "nullable": true }, "Level": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AccountSingleOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "AccountNumber": { "type": "integer", "format": "int64" }, "Email": { "type": "string", "nullable": true }, "FirstName": { "type": "string", "nullable": true }, "LastName": { "type": "string", "nullable": true }, "Street1": { "type": "string", "nullable": true }, "Street2": { "type": "string", "nullable": true }, "City": { "type": "string", "nullable": true }, "Region": { "type": "string", "nullable": true }, "Country": { "type": "string", "nullable": true }, "PostalCode": { "type": "string", "nullable": true }, "Phone": { "type": "string", "nullable": true }, "Address": { "type": "string", "nullable": true }, "CreatedAt": { "type": "string", "format": "date-time" }, "IsUser": { "type": "boolean" }, "AvatarUrl": { "type": "string", "nullable": true }, "IsBrushfireStaff": { "type": "boolean" } }, "additionalProperties": false }, "ApiError": { "type": "object", "properties": { "Message": { "type": "string", "nullable": true }, "Data": { "nullable": true }, "StackTrace": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ApiModelError": { "type": "object", "properties": { "Errors": { "type": "array", "items": { "$ref": "#/components/schemas/StringStringKeyValuePair" }, "nullable": true }, "Message": { "type": "string", "nullable": true }, "Data": { "nullable": true }, "StackTrace": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AttendeeCancelInput": { "type": "object", "properties": { "Penalty": { "type": "number", "format": "double" }, "AccessKey": { "type": "string", "nullable": true }, "SendEmail": { "type": "boolean" }, "ReservedStateId": { "type": "integer", "format": "int32", "nullable": true }, "Via": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AttendeeChangeType": { "enum": [ "All", "Positive", "None" ], "type": "string" }, "AttendeeCheckinOutput": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "SessionNumber": { "type": "integer", "format": "int64" }, "CheckedInAt": { "type": "string", "format": "date-time", "nullable": true }, "CheckedIn": { "type": "boolean" }, "IsHidden": { "type": "boolean" } }, "additionalProperties": false }, "AttendeeCodeInput": { "type": "object", "properties": { "AttendeeCode": { "type": "string", "nullable": true }, "AccessKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AttendeeCommunityInput": { "type": "object", "properties": { "CommunityId": { "type": "string", "format": "uuid", "nullable": true }, "AccessKey": { "type": "string", "nullable": true }, "OverrideCapacity": { "type": "boolean" }, "OverrideGroup": { "type": "boolean" } }, "additionalProperties": false }, "AttendeeCommunityOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Partition": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "Capacity": { "type": "integer", "format": "int32" }, "AttendeeCount": { "type": "integer", "format": "int32" }, "GroupCount": { "type": "integer", "format": "int32" }, "Tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "RemainingCount": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "AttendeeCompletedInput": { "required": [ "IsCompleted" ], "type": "object", "properties": { "AccessKey": { "type": "string", "nullable": true }, "IsCompleted": { "type": "boolean" } }, "additionalProperties": false }, "AttendeeConversionResult": { "type": "object", "properties": { "AttendeeNumber": { "type": "integer", "description": "The original attendee number requested", "format": "int64" }, "AttendeeId": { "type": "string", "description": "The unique identifier if conversion was successful", "format": "uuid", "nullable": true }, "Success": { "type": "boolean", "description": "Whether the conversion was successful" }, "Message": { "type": "string", "description": "Reason for failure if unsuccessful", "nullable": true } }, "additionalProperties": false, "description": "Result of converting an attendee number to a unique identifier" }, "AttendeeDetailsOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "AttendeeNumber": { "type": "integer", "format": "int64" }, "AttendeeCode": { "type": "string", "nullable": true }, "EventId": { "type": "string", "format": "uuid" }, "EventNumber": { "type": "integer", "format": "int64" }, "Status": { "type": "string", "nullable": true }, "IsCompleted": { "type": "boolean" }, "IsGift": { "type": "boolean" }, "IsPreRegistered": { "type": "boolean" }, "IsPrinted": { "type": "boolean" }, "ShareEmail": { "type": "string", "nullable": true }, "GiftLastSentAt": { "type": "string", "format": "date-time", "nullable": true }, "FirstName": { "type": "string", "nullable": true }, "LastName": { "type": "string", "nullable": true }, "Phone": { "type": "string", "nullable": true }, "Email": { "type": "string", "nullable": true }, "Street1": { "type": "string", "nullable": true }, "Street2": { "type": "string", "nullable": true }, "City": { "type": "string", "nullable": true }, "Region": { "type": "string", "nullable": true }, "Country": { "type": "string", "nullable": true }, "PostalCode": { "type": "string", "nullable": true }, "TypeId": { "type": "string", "format": "uuid" }, "TypeName": { "type": "string", "nullable": true }, "SectionName": { "type": "string", "nullable": true }, "RowName": { "type": "string", "nullable": true }, "SeatLabel": { "type": "string", "nullable": true }, "Wheelchair": { "type": "boolean", "nullable": true }, "LimitedView": { "type": "boolean", "nullable": true }, "Amount": { "type": "number", "format": "double" }, "SeatInfo": { "type": "string", "nullable": true, "readOnly": true }, "CommunityId": { "type": "string", "format": "uuid", "nullable": true }, "CommunityName": { "type": "string", "nullable": true }, "CommunityPartition": { "type": "string", "nullable": true }, "GroupId": { "type": "string", "format": "uuid", "nullable": true }, "GroupName": { "type": "string", "nullable": true }, "GroupEmail": { "type": "string", "nullable": true }, "Fields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldDisplayOutput" }, "nullable": true }, "OrderFields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldDisplayOutput" }, "nullable": true }, "GroupFields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldDisplayOutput" }, "nullable": true }, "Checkins": { "type": "array", "items": { "$ref": "#/components/schemas/AttendeeCheckinOutput" }, "nullable": true }, "FlexPassCheckins": { "type": "array", "items": { "$ref": "#/components/schemas/AttendeeFlexPassCheckinOutput" }, "nullable": true }, "QRCode": { "type": "string", "nullable": true }, "IsAnonymized": { "type": "boolean" }, "FlexPass": { "$ref": "#/components/schemas/AttendeeFlexPassOutput" }, "IsFlexPass": { "type": "boolean" }, "AttendeeDisplay": { "$ref": "#/components/schemas/AttendeeDisplayOutput" }, "AttendeeDisplayLines": { "$ref": "#/components/schemas/AttendeeDisplayOutput" }, "OrderedAt": { "type": "string", "format": "date-time", "nullable": true }, "ShareEnabled": { "type": "boolean" }, "IsAddon": { "type": "boolean" }, "GeneratesTicket": { "type": "boolean" }, "OrderKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AttendeeDisplayOutput": { "type": "object", "properties": { "Line1": { "type": "string", "nullable": true }, "Line2": { "type": "string", "nullable": true }, "Line3": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AttendeeDonateInput": { "type": "object", "properties": { "AccessKey": { "type": "string", "nullable": true }, "SendEmail": { "type": "boolean" }, "ReservedStateId": { "type": "integer", "format": "int32", "nullable": true }, "Via": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AttendeeFlexPassCheckinOutput": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "SessionNumber": { "type": "integer", "format": "int64" }, "CheckedInAt": { "type": "string", "format": "date-time", "nullable": true }, "AttendeeCheckinId": { "type": "string", "format": "uuid", "nullable": true }, "EventNumber": { "type": "integer", "format": "int64" }, "TitleInfo": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AttendeeFlexPassOutput": { "type": "object", "properties": { "FlexTotal": { "type": "integer", "format": "int32", "nullable": true }, "FlexPer": { "type": "integer", "format": "int32", "nullable": true }, "FlexStartsAt": { "type": "string", "format": "date-time", "nullable": true }, "FlexEndsAt": { "type": "string", "format": "date-time", "nullable": true }, "FlexSummary": { "type": "string", "nullable": true }, "FlexRedemptions": { "type": "integer", "format": "int32" }, "FlexRedemptionsText": { "type": "string", "nullable": true }, "FlexRelativeDays": { "type": "integer", "format": "int32", "nullable": true }, "EventRedemptions": { "type": "integer", "format": "int32", "nullable": true }, "EventRedemptionsText": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AttendeeGroupInput": { "type": "object", "properties": { "GroupId": { "type": "string", "nullable": true }, "OverrideCommunityCapacity": { "type": "boolean" }, "AccessKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AttendeeHelpdeskOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "AttendeeNumber": { "type": "integer", "format": "int64" }, "EventNumber": { "type": "integer", "format": "int64" }, "EventTitle": { "type": "string", "nullable": true }, "EventSubtitle": { "type": "string", "nullable": true }, "Status": { "type": "string", "nullable": true }, "FirstName": { "type": "string", "nullable": true }, "LastName": { "type": "string", "nullable": true }, "TypeName": { "type": "string", "nullable": true }, "Amount": { "type": "number", "format": "double" }, "SeatInfo": { "type": "string", "nullable": true }, "Culture": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AttendeeLinkInput": { "type": "object", "properties": { "SourceAttendeeId": { "type": "string", "nullable": true }, "AccessKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AttendeeNumbersToIdsInput": { "required": [ "AttendeeNumbers" ], "type": "object", "properties": { "AttendeeNumbers": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "List of attendee numbers to convert to unique identifiers" } }, "additionalProperties": false, "description": "Input model for converting attendee numbers to unique identifiers" }, "AttendeeNumbersToIdsOutput": { "type": "object", "properties": { "Results": { "type": "array", "items": { "$ref": "#/components/schemas/AttendeeConversionResult" }, "description": "List of results for each requested attendee number", "nullable": true } }, "additionalProperties": false, "description": "Output model containing converted attendee identifiers and status information" }, "AttendeePrintInput": { "required": [ "Attendees", "EventId", "Type" ], "type": "object", "properties": { "Type": { "$ref": "#/components/schemas/PrintType" }, "Attendees": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "EventId": { "minLength": 1, "type": "string" }, "Format": { "$ref": "#/components/schemas/PrintFormat" }, "ImageDpi": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AttendeeTypeCategory": { "enum": [ "All", "Standard", "Addon" ], "type": "string" }, "AttendeeUpdateGiftInput": { "type": "object", "properties": { "IsGift": { "type": "boolean" }, "FromName": { "type": "string", "nullable": true }, "FromEmail": { "pattern": "^([0-9A-Za-z\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff']+[-._+&])*[0-9A-Za-z\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff_']+@([-0-9A-Za-z\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff]+[.])+[a-zA-Z]{2,63}$", "type": "string", "nullable": true }, "RecipientEmail": { "pattern": "^([0-9A-Za-z\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff']+[-._+&])*[0-9A-Za-z\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff_']+@([-0-9A-Za-z\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff]+[.])+[a-zA-Z]{2,63}$", "type": "string", "nullable": true }, "RecipientMessage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AttendeeUpdateGiftOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "AttendeeNumber": { "type": "integer", "format": "int64" }, "EventId": { "type": "string", "format": "uuid" }, "AttendeeTypeId": { "type": "string", "format": "uuid" }, "AttendeeCode": { "type": "string", "nullable": true }, "GroupId": { "type": "string", "format": "uuid", "nullable": true }, "IsCompleted": { "type": "boolean" }, "CurrentOrderId": { "type": "string", "format": "uuid", "nullable": true }, "OriginalOrderId": { "type": "string", "format": "uuid", "nullable": true }, "CartId": { "type": "string", "nullable": true }, "IsGift": { "type": "boolean" }, "IsPreRegistered": { "type": "boolean" }, "RecipientEmail": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AttendeeUpdateTypeInput": { "required": [ "AttendeeTypeId" ], "type": "object", "properties": { "AccessKey": { "type": "string", "nullable": true }, "AttendeeTypeId": { "type": "string", "format": "uuid" }, "Amount": { "type": "number", "format": "double", "nullable": true }, "SendEmail": { "type": "boolean" }, "Via": { "type": "string", "nullable": true }, "ExternalDescription": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CartAddAttendeeInput": { "required": [ "Attendees" ], "type": "object", "properties": { "Attendees": { "type": "array", "items": { "$ref": "#/components/schemas/CartAddAttendeeItemInput" } }, "TypeCode": { "type": "string", "nullable": true }, "AccessKey": { "type": "string", "nullable": true }, "Exclude": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CartAddAttendeeItemInput": { "required": [ "EventId", "Quantity", "TypeId" ], "type": "object", "properties": { "EventId": { "minLength": 1, "type": "string" }, "TypeId": { "type": "string", "format": "uuid" }, "Quantity": { "type": "integer", "format": "int32" }, "GroupId": { "type": "string", "nullable": true }, "Amount": { "type": "number", "format": "double" }, "IsPreRegistered": { "type": "boolean" }, "CustomAmount": { "type": "number", "format": "double", "nullable": true }, "SelectedAmount": { "type": "number", "format": "double", "nullable": true }, "SeatId": { "type": "string", "format": "uuid", "nullable": true }, "SectionId": { "type": "string", "format": "uuid", "nullable": true }, "ExternalId": { "type": "string", "nullable": true }, "ExternalDescription": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CartAddAttendeeOutput": { "type": "object", "properties": { "CartId": { "type": "string", "nullable": true }, "ExpiresAt": { "type": "string", "format": "date-time", "nullable": true }, "TotalCount": { "type": "integer", "format": "int32" }, "AddedCount": { "type": "integer", "format": "int32" }, "EventCart": { "$ref": "#/components/schemas/CartEventOutput" } }, "additionalProperties": false }, "CartAddPromotionInput": { "required": [ "CodeName" ], "type": "object", "properties": { "CodeName": { "minLength": 1, "type": "string" }, "AccessKey": { "type": "string", "nullable": true }, "Exclude": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CartAttendeeFormInput": { "type": "object", "properties": { "AccessKey": { "type": "string", "nullable": true }, "FieldValues": { "type": "array", "items": { "$ref": "#/components/schemas/FieldInput" }, "nullable": true }, "UpdateNewOnly": { "type": "boolean" }, "IsPreRegistered": { "type": "boolean" }, "IsGift": { "type": "boolean" }, "RecipientEmail": { "pattern": "^([0-9A-Za-z\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff']+[-._+&])*[0-9A-Za-z\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff_']+@([-0-9A-Za-z\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff]+[.])+[a-zA-Z]{2,63}$", "type": "string", "nullable": true } }, "additionalProperties": false }, "CartAttendeeOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "EventId": { "type": "string", "format": "uuid" }, "AttendeeTypeId": { "type": "string", "format": "uuid" }, "AttendeeId": { "type": "string", "format": "uuid" }, "AttendeeNumber": { "type": "integer", "format": "int64" }, "LinkedAttendeeNumber": { "type": "integer", "format": "int64", "nullable": true }, "GroupId": { "type": "string", "format": "uuid", "nullable": true }, "CartId": { "type": "string", "nullable": true }, "UnitPrice": { "type": "number", "format": "double" }, "UnitFee": { "type": "number", "format": "double" }, "UnitTax": { "type": "number", "format": "double" }, "UnitDelivery": { "type": "number", "description": "Deprecated. Delivery has been folded into API.Models.CartAttendeeOutput.UnitFee; this property is kept for backwards compatibility but should be ignored.", "format": "double" }, "UnitDiscount": { "type": "number", "format": "double" }, "UnitAddons": { "type": "number", "format": "double" }, "UnitTotal": { "type": "number", "format": "double" }, "UnitFees": { "type": "array", "items": { "$ref": "#/components/schemas/UnitFeeLineItemOutput" }, "nullable": true }, "DisplayPrice": { "type": "number", "format": "double" }, "DisplayTotal": { "type": "number", "format": "double", "readOnly": true }, "TypeDisplayAmount": { "type": "number", "format": "double" }, "IsInclusiveFees": { "type": "boolean" }, "IsInclusiveTaxes": { "type": "boolean" }, "LastAccessedAt": { "type": "string", "format": "date-time" }, "TypeName": { "type": "string", "nullable": true }, "IsPreRegistered": { "type": "boolean" }, "IsCompleted": { "type": "boolean" }, "IsGift": { "type": "boolean" }, "CanContinue": { "type": "boolean" }, "SeatId": { "type": "string", "format": "uuid", "nullable": true }, "SectionName": { "type": "string", "nullable": true }, "RowName": { "type": "string", "nullable": true }, "SeatLabel": { "type": "string", "nullable": true }, "DistanceCount": { "type": "integer", "format": "int32", "nullable": true }, "ShareEmail": { "type": "string", "nullable": true }, "SeatInfo": { "type": "string", "nullable": true }, "HasFields": { "type": "boolean" }, "Promotions": { "type": "array", "items": { "$ref": "#/components/schemas/CartAttendeePromotionOutput" }, "nullable": true }, "Fields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldDisplayOutput" }, "nullable": true }, "FirstName": { "type": "string", "nullable": true }, "LastName": { "type": "string", "nullable": true }, "HasName": { "type": "boolean" }, "HasAddress": { "type": "boolean" }, "DisplayName": { "type": "string", "nullable": true }, "AttendeeDisplay": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "AttendeeDisplayLines": { "$ref": "#/components/schemas/AttendeeDisplayOutput" }, "IsAddon": { "type": "boolean" }, "TypeKind": { "$ref": "#/components/schemas/TypeKind" }, "ExternalId": { "type": "string", "nullable": true }, "ExternalDescription": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CartAttendeePromotionOutput": { "type": "object", "properties": { "PromotionId": { "type": "string", "format": "uuid" }, "DiscountAmount": { "type": "number", "format": "double" } }, "additionalProperties": false }, "CartCheckoutInfoOutput": { "type": "object", "properties": { "FirstName": { "type": "string", "nullable": true }, "LastName": { "type": "string", "nullable": true }, "Phone": { "type": "string", "nullable": true }, "Email": { "type": "string", "nullable": true }, "Street1": { "type": "string", "nullable": true }, "Street2": { "type": "string", "nullable": true }, "City": { "type": "string", "nullable": true }, "Region": { "type": "string", "nullable": true }, "Country": { "type": "string", "nullable": true }, "PostalCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CartDeleteAttendeeOutput": { "type": "object", "properties": { "ExpiresAt": { "type": "string", "format": "date-time", "nullable": true }, "TotalCount": { "type": "integer", "format": "int32" }, "DeletedCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CartDeleteEventOutput": { "type": "object", "properties": { "DeletedCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CartDeletePromotionOutput": { "type": "object", "properties": { "DeletedCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CartEventDeliveryMethodOutput": { "type": "object", "properties": { "ShippingId": { "type": "string", "format": "uuid" }, "Method": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "EventFee": { "type": "number", "format": "double", "nullable": true }, "TicketFee": { "type": "number", "format": "double", "nullable": true }, "IsElectronic": { "type": "boolean" }, "IsPointOfSale": { "type": "boolean" }, "PricesVary": { "type": "boolean" }, "TicketCount": { "type": "integer", "format": "int32", "nullable": true }, "Fee": { "type": "number", "format": "double", "readOnly": true } }, "additionalProperties": false, "description": "Deprecated. Delivery has been folded into API.Models.CartAttendeeOutput.UnitFee; this class is kept for backwards compatibility but ignored." }, "CartEventOutput": { "type": "object", "properties": { "ExpiresAt": { "type": "string", "format": "date-time", "nullable": true }, "ShowPromos": { "type": "boolean" }, "Id": { "type": "string", "format": "uuid" }, "EventId": { "type": "string", "format": "uuid" }, "ClientId": { "type": "string", "format": "uuid" }, "ClientNumber": { "type": "integer", "format": "int64" }, "EventNumber": { "type": "integer", "format": "int64" }, "EventAcctCode": { "type": "string", "nullable": true }, "ClientKey": { "type": "string", "nullable": true }, "UrlKey": { "type": "string", "nullable": true }, "Title": { "type": "string", "nullable": true }, "Dates": { "type": "array", "items": { "$ref": "#/components/schemas/EventDateOutput" }, "nullable": true }, "Culture": { "type": "string", "nullable": true }, "TicketLimit": { "type": "integer", "format": "int32", "nullable": true }, "DeliveryFee": { "type": "number", "description": "Deprecated. Delivery has been folded into API.Models.CartAttendeeOutput.UnitFee;", "format": "double" }, "ShippingId": { "type": "string", "description": "Deprecated. Delivery has been folded into API.Models.CartAttendeeOutput.UnitFee;", "format": "uuid", "nullable": true }, "ShippingIsElectronic": { "type": "boolean", "description": "Deprecated. Delivery has been folded into API.Models.CartAttendeeOutput.UnitFee;", "nullable": true }, "ShippingIsPOS": { "type": "boolean", "description": "Deprecated. Delivery has been folded into API.Models.CartAttendeeOutput.UnitFee;", "nullable": true }, "IsCompleted": { "type": "boolean" }, "PaymentProfileId": { "type": "string", "format": "uuid", "nullable": true }, "CartId": { "type": "string", "nullable": true }, "AnalyticsNumber": { "type": "string", "nullable": true }, "HasFields": { "type": "boolean" }, "TimeZoneId": { "type": "string", "nullable": true }, "ImInImageUrl": { "type": "string", "nullable": true }, "LockInGroups": { "type": "boolean" }, "ShippingIdName": { "type": "string", "description": "Deprecated. Delivery has been folded into API.Models.CartAttendeeOutput.UnitFee;", "nullable": true }, "CanContinue": { "type": "boolean" }, "GatewayDescription": { "type": "string", "nullable": true, "readOnly": true }, "Verbiage": { "type": "string", "nullable": true }, "VerbiageSetting": { "$ref": "#/components/schemas/EventVerbiage" }, "SubTotal": { "type": "number", "format": "double", "readOnly": true }, "EventTotal": { "type": "number", "format": "double", "readOnly": true }, "TitleInfo": { "type": "string", "nullable": true }, "DateInfo": { "type": "string", "nullable": true }, "Items": { "type": "array", "items": { "$ref": "#/components/schemas/CartAttendeeOutput" }, "nullable": true }, "DeliveryMethods": { "type": "array", "items": { "$ref": "#/components/schemas/CartEventDeliveryMethodOutput" }, "description": "Deprecated. Delivery has been folded into API.Models.CartAttendeeOutput.UnitFee;", "nullable": true }, "PaymentMethods": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethodOutput" }, "nullable": true }, "Promotions": { "type": "array", "items": { "$ref": "#/components/schemas/CartPromotionOutput" }, "nullable": true }, "StartsAt": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "AreaKey": { "type": "string", "nullable": true }, "CheckoutInfo": { "$ref": "#/components/schemas/CartCheckoutInfoOutput" }, "OrderFee": { "type": "number", "description": "Deprecated. Order fee has been folded into API.Models.CartAttendeeOutput.UnitFee;", "format": "double" }, "TaxLabel": { "type": "string", "nullable": true }, "TaxTotal": { "type": "number", "format": "double" }, "FeeTotal": { "type": "number", "format": "double" }, "DiscountTotal": { "type": "number", "format": "double", "readOnly": true }, "AttendeeTotal": { "type": "number", "format": "double", "readOnly": true } }, "additionalProperties": false }, "CartIdOutput": { "type": "object", "properties": { "CartId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CartLookupOutput": { "type": "object", "properties": { "AccountNumber": { "type": "integer", "format": "int64", "nullable": true }, "IsLegacy": { "type": "boolean" }, "FirstName": { "type": "string", "nullable": true }, "LastName": { "type": "string", "nullable": true }, "Organization": { "type": "string", "nullable": true }, "Street1": { "type": "string", "nullable": true }, "Street2": { "type": "string", "nullable": true }, "City": { "type": "string", "nullable": true }, "Region": { "type": "string", "nullable": true }, "Country": { "type": "string", "nullable": true }, "PostalCode": { "type": "string", "nullable": true }, "Email": { "type": "string", "nullable": true }, "Phone": { "type": "string", "nullable": true }, "Relevancy": { "type": "number", "format": "double" } }, "additionalProperties": false }, "CartPromotionOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Names": { "type": "array", "items": { "type": "string" }, "nullable": true }, "Amount": { "type": "number", "format": "double" }, "AutoCalculate": { "type": "boolean" } }, "additionalProperties": false }, "CartUpdateAttendeeInput": { "type": "object", "properties": { "AccessKey": { "type": "string", "nullable": true }, "AttendeeTypeId": { "type": "string", "format": "uuid", "nullable": true }, "GroupId": { "type": "string", "format": "uuid", "nullable": true }, "UnitPrice": { "type": "number", "format": "double", "nullable": true }, "UnitAddons": { "type": "number", "format": "double", "nullable": true }, "UnitDiscount": { "type": "number", "format": "double", "nullable": true }, "UnitTax": { "type": "number", "description": "Flat tax amount applied to this attendee. Ignored when API.Models.CartUpdateAttendeeInput.UnitFees is supplied.", "format": "double", "nullable": true }, "UnitFee": { "type": "number", "description": "Flat fee amount applied to this attendee. Ignored when API.Models.CartUpdateAttendeeInput.UnitFees is supplied.", "format": "double", "nullable": true }, "UnitFees": { "type": "array", "items": { "$ref": "#/components/schemas/UnitFeeLineItemInput" }, "description": "Itemized fee/tax line items to apply to this attendee.\r\nWhen supplied, takes precedence over API.Models.CartUpdateAttendeeInput.UnitFee and API.Models.CartUpdateAttendeeInput.UnitTax.", "nullable": true }, "UnitDelivery": { "type": "number", "description": "Deprecated. Delivery has been folded into API.Models.CartUpdateAttendeeInput.UnitFee; this field is accepted for backwards compatibility but ignored.", "format": "double", "nullable": true }, "Exclude": { "type": "string", "nullable": true }, "ExternalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CartUpdateEventInput": { "type": "object", "properties": { "AccessKey": { "type": "string", "nullable": true }, "ShippingId": { "type": "string", "description": "Deprecated. Delivery methods are no longer supported; this field is accepted for backwards compatibility but ignored.", "format": "uuid", "nullable": true }, "UnitPrice": { "type": "number", "format": "double", "nullable": true }, "UnitAddons": { "type": "number", "format": "double", "nullable": true }, "UnitDiscount": { "type": "number", "format": "double", "nullable": true }, "UnitTax": { "type": "number", "description": "Flat tax amount applied to each attendee. Ignored when API.Models.CartUpdateEventInput.UnitFees is supplied.", "format": "double", "nullable": true }, "UnitFee": { "type": "number", "description": "Flat fee amount applied to each attendee. Ignored when API.Models.CartUpdateEventInput.UnitFees is supplied.", "format": "double", "nullable": true }, "UnitFees": { "type": "array", "items": { "$ref": "#/components/schemas/UnitFeeLineItemInput" }, "description": "Itemized fee/tax line items to apply to every attendee in the cart for this event.\r\nWhen supplied, this replaces the existing UnitFeesJson on each attendee and takes precedence over API.Models.CartUpdateEventInput.UnitFee and API.Models.CartUpdateEventInput.UnitTax.\r\nIf the existing attendees already have tax applied, the list must include at least one entry with FeeType=Tax.", "nullable": true }, "UnitDelivery": { "type": "number", "description": "Deprecated. Delivery has been folded into API.Models.CartUpdateEventInput.UnitFee; this field is accepted for backwards compatibility but ignored.", "format": "double", "nullable": true }, "DeliveryFee": { "type": "number", "description": "Deprecated. Delivery is no longer included in order totals; this field is accepted for backwards compatibility but ignored.", "format": "double", "nullable": true }, "Exclude": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ClientListOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "ClientNumber": { "type": "integer", "format": "int64" }, "ClientKey": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "CreatedAt": { "type": "string", "format": "date-time" }, "City": { "type": "string", "nullable": true }, "Region": { "type": "string", "nullable": true }, "Country": { "type": "string", "nullable": true }, "IsLive": { "type": "boolean" }, "IsDeleted": { "type": "boolean" } }, "additionalProperties": false }, "ClientSingleOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Name": { "type": "string", "nullable": true }, "City": { "type": "string", "nullable": true }, "Region": { "type": "string", "nullable": true }, "Country": { "type": "string", "nullable": true }, "Coordinates": { "type": "string", "nullable": true }, "ClientKey": { "type": "string", "nullable": true }, "ClientNumber": { "type": "integer", "format": "int64" }, "OwnerUserId": { "type": "string", "format": "uuid" }, "BillingUserId": { "type": "string", "format": "uuid" }, "CrmId": { "type": "string", "nullable": true }, "Culture": { "type": "string", "nullable": true }, "TimeZoneId": { "type": "string", "nullable": true }, "LegacyClientId": { "type": "integer", "format": "int64", "nullable": true }, "PartnerId": { "type": "string", "format": "uuid", "nullable": true }, "HubSpotCompanyId": { "type": "string", "nullable": true }, "ChmsVendor": { "type": "string", "nullable": true }, "ChmsQualifier": { "type": "string", "nullable": true }, "ChmsAuthToken": { "type": "string", "nullable": true }, "ChmsAuthSecret": { "type": "string", "nullable": true }, "ChmsUserToken": { "type": "string", "nullable": true }, "ChmsUserSecret": { "type": "string", "nullable": true }, "ChmsServiceName": { "type": "string", "nullable": true }, "ChmsHtmlTemplate": { "type": "string", "nullable": true }, "ChmsOauthConnect": { "type": "boolean", "nullable": true }, "ChmsIsLive": { "type": "boolean", "nullable": true }, "CreatedAt": { "type": "string", "format": "date-time" }, "IsLive": { "type": "boolean" }, "PayVia": { "type": "string", "nullable": true }, "MissingPaymentInfo": { "type": "boolean" }, "FailedPaymentDetails": { "type": "string", "nullable": true }, "CardExpire": { "type": "string", "nullable": true }, "IsDeleted": { "type": "boolean" }, "LastPaidAt": { "type": "string", "format": "date-time", "nullable": true }, "CurrentBalance": { "type": "number", "format": "double" }, "BillingTotal": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ColorOutput": { "type": "object", "properties": { "RGB": { "type": "string", "nullable": true }, "Hex": { "type": "string", "nullable": true }, "Alpha": { "type": "number", "format": "double" } }, "additionalProperties": false }, "CopyFeesType": { "enum": [ "Client", "Original" ], "type": "string" }, "CustomFeeOutput": { "type": "object", "properties": { "Label": { "type": "string", "description": "Display label shown to attendees (e.g. \"Sales Tax\", \"Service Fee\").", "nullable": true }, "FeeType": { "$ref": "#/components/schemas/FeeItemType" }, "Flat": { "type": "number", "description": "Flat per-attendee amount, if applicable.", "format": "double", "nullable": true }, "Percent": { "type": "number", "description": "Percent of base price (0\u2013100). Applies to both Fee and Tax rows.", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "A single custom fee or tax row from an attendee type's CustomFeesJson." }, "CustomQueryGranularity": { "enum": [ "Minute", "Hour", "Day" ], "type": "string" }, "DateDisplayOutput": { "type": "object", "properties": { "Months": { "type": "string", "nullable": true }, "Dates": { "type": "string", "nullable": true }, "Days": { "type": "string", "nullable": true }, "Times": { "type": "string", "nullable": true }, "IsOngoing": { "type": "boolean" } }, "additionalProperties": false }, "DomainValidationOutput": { "type": "object", "properties": { "AllowDomains": { "type": "array", "items": { "type": "string" }, "nullable": true }, "DisallowDomains": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "DomainValidationType": { "enum": [ "All", "Only", "None" ], "type": "string" }, "EventAddonCreateInput": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "AdminShowAt": { "type": "string", "format": "date-time", "nullable": true }, "AdminHideAt": { "type": "string", "format": "date-time", "nullable": true }, "InternetShowAt": { "type": "string", "format": "date-time", "nullable": true }, "InternetHideAt": { "type": "string", "format": "date-time", "nullable": true }, "IsHidden": { "type": "boolean" }, "Capacity": { "type": "integer", "format": "int32", "nullable": true }, "RoleName": { "type": "string", "nullable": true }, "Amount": { "type": "number", "format": "double" }, "MinQuantity": { "type": "integer", "format": "int32", "nullable": true }, "MaxQuantity": { "type": "integer", "format": "int32", "nullable": true }, "NoChangesAfter": { "type": "string", "format": "date-time", "nullable": true }, "Custom1": { "type": "string", "nullable": true }, "Custom2": { "type": "string", "nullable": true }, "Custom3": { "type": "string", "nullable": true }, "AcctCode": { "type": "string", "nullable": true }, "GroupingText": { "type": "string", "nullable": true }, "TypeKind": { "$ref": "#/components/schemas/TypeKind" }, "FlexTotal": { "type": "integer", "description": "Total number of redemptions. Only applicable for Flex Pass events.", "format": "int32", "nullable": true }, "FlexPer": { "type": "integer", "description": "Maximum number of redemptions per event. Only applicable for Flex Pass events.", "format": "int32", "nullable": true }, "FlexStartsAt": { "type": "string", "description": "When can redemptions start? Only applicable for Flex Pass events without Flex Relative Days.\r\nIf Flex Relative Days is set, this will be ignored.", "format": "date-time", "nullable": true }, "FlexEndsAt": { "type": "string", "description": "When will redemptions end? Only applicable for Flex Pass events without Flex Relative Days.\r\nIf Flex Relative Days is set, this will be ignored.", "format": "date-time", "nullable": true }, "ConnectedFlexEventUrlKeys": { "type": "array", "items": { "type": "string" }, "description": "What events can this flex pass be redeemed for? Set \"all\" to allow all events.", "nullable": true }, "FlexRelativeDays": { "type": "integer", "description": "For how many days is the flex pass redeemable after purchase? Only applicable for Flex Pass events.\r\nIf Flex Relative Days is set, FlexStartsAt and FlexEndsAt will be ignored.", "format": "int32", "nullable": true }, "CustomHtml": { "type": "string", "nullable": true }, "ShareEnabled": { "type": "boolean" }, "GeneratesTicket": { "type": "boolean" }, "TypeTicketImageUrl": { "type": "string", "nullable": true }, "TypeTicketBackgroundColor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EventAttendeeFieldCreateInput": { "type": "object", "properties": { "IsPrimaryEmail": { "type": "boolean", "description": "This is used to mark the field as primary email field for the attendee." }, "Label": { "type": "string", "nullable": true }, "FieldType": { "$ref": "#/components/schemas/FieldType" }, "ValidationExpression": { "type": "string", "nullable": true }, "StoredValue": { "type": "string", "nullable": true }, "Notes": { "type": "string", "nullable": true }, "AdminRequired": { "type": "boolean" }, "AdminVisible": { "type": "boolean" }, "InternetRequired": { "type": "boolean" }, "InternetVisible": { "type": "boolean" }, "IsSensitive": { "type": "boolean" }, "Options": { "type": "array", "items": { "$ref": "#/components/schemas/EventFieldOptionCreateInput" }, "description": "Only set for fields of type Checkbox, Dropdown, Radiobuttons, ItemList, or ItemAmount", "nullable": true }, "RemoteUrl": { "type": "string", "description": "Only set for fields of type RemoteFetch or RemoteValidate", "nullable": true }, "RequireConfirm": { "type": "boolean", "description": "Only set for fields of type Text, Name, Phone, Email, or Date" }, "EmailDomains": { "type": "array", "items": { "type": "string" }, "description": "The list of domains you would like to validate for or against for email fields.", "nullable": true }, "DomainValidation": { "$ref": "#/components/schemas/DomainValidationType" } }, "additionalProperties": false }, "EventAttendeeTypeCreateInput": { "type": "object", "properties": { "PriceMethod": { "$ref": "#/components/schemas/PriceMethod" }, "AllowCustomAmount": { "type": "boolean" }, "AllowedPayments": { "type": "array", "items": { "type": "number", "format": "double" }, "nullable": true }, "PaymentsDue": { "type": "string", "format": "date-time", "nullable": true }, "FeeMethod": { "$ref": "#/components/schemas/FeeMethod" }, "Fee": { "type": "number", "description": "Deprecated. Fees are now configured via customFees written through the EventCreator UI; this field is accepted for backwards compatibility but ignored.", "format": "double", "nullable": true }, "FeePercent": { "maximum": 100, "minimum": 0, "type": "number", "description": "Deprecated. Fees are now configured via customFees written through the EventCreator UI; this field is accepted for backwards compatibility but ignored.", "format": "double", "nullable": true }, "GroupsEnabled": { "type": "boolean" }, "BypassGroupReq": { "type": "boolean" }, "GiftingEnabled": { "type": "boolean" }, "PreRegEnabled": { "type": "boolean" }, "CopyEnabled": { "type": "boolean" }, "AdvertisePrice": { "type": "boolean" }, "Name": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "AdminShowAt": { "type": "string", "format": "date-time", "nullable": true }, "AdminHideAt": { "type": "string", "format": "date-time", "nullable": true }, "InternetShowAt": { "type": "string", "format": "date-time", "nullable": true }, "InternetHideAt": { "type": "string", "format": "date-time", "nullable": true }, "IsHidden": { "type": "boolean" }, "Capacity": { "type": "integer", "format": "int32", "nullable": true }, "RoleName": { "type": "string", "nullable": true }, "Amount": { "type": "number", "format": "double" }, "MinQuantity": { "type": "integer", "format": "int32", "nullable": true }, "MaxQuantity": { "type": "integer", "format": "int32", "nullable": true }, "NoChangesAfter": { "type": "string", "format": "date-time", "nullable": true }, "Custom1": { "type": "string", "nullable": true }, "Custom2": { "type": "string", "nullable": true }, "Custom3": { "type": "string", "nullable": true }, "AcctCode": { "type": "string", "nullable": true }, "GroupingText": { "type": "string", "nullable": true }, "TypeKind": { "$ref": "#/components/schemas/TypeKind" }, "FlexTotal": { "type": "integer", "description": "Total number of redemptions. Only applicable for Flex Pass events.", "format": "int32", "nullable": true }, "FlexPer": { "type": "integer", "description": "Maximum number of redemptions per event. Only applicable for Flex Pass events.", "format": "int32", "nullable": true }, "FlexStartsAt": { "type": "string", "description": "When can redemptions start? Only applicable for Flex Pass events without Flex Relative Days.\r\nIf Flex Relative Days is set, this will be ignored.", "format": "date-time", "nullable": true }, "FlexEndsAt": { "type": "string", "description": "When will redemptions end? Only applicable for Flex Pass events without Flex Relative Days.\r\nIf Flex Relative Days is set, this will be ignored.", "format": "date-time", "nullable": true }, "ConnectedFlexEventUrlKeys": { "type": "array", "items": { "type": "string" }, "description": "What events can this flex pass be redeemed for? Set \"all\" to allow all events.", "nullable": true }, "FlexRelativeDays": { "type": "integer", "description": "For how many days is the flex pass redeemable after purchase? Only applicable for Flex Pass events.\r\nIf Flex Relative Days is set, FlexStartsAt and FlexEndsAt will be ignored.", "format": "int32", "nullable": true }, "CustomHtml": { "type": "string", "nullable": true }, "ShareEnabled": { "type": "boolean" }, "GeneratesTicket": { "type": "boolean" }, "TypeTicketImageUrl": { "type": "string", "nullable": true }, "TypeTicketBackgroundColor": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EventCommunityOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Partition": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "Capacity": { "type": "integer", "format": "int32" }, "AttendeeCount": { "type": "integer", "format": "int32" }, "GroupCount": { "type": "integer", "format": "int32" }, "Tags": { "type": "array", "items": { "type": "string" }, "nullable": true }, "RemainingCount": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "EventCopyInput": { "required": [ "AccessKey", "CopyFees", "SourceEventId", "Title", "UrlKey" ], "type": "object", "properties": { "AccessKey": { "minLength": 1, "type": "string", "description": "Your account access key. This is used to authenticate your requests." }, "SourceEventId": { "type": "string", "format": "uuid" }, "Title": { "minLength": 1, "type": "string", "description": "Event title", "example": "My New Event" }, "Subtitle": { "type": "string", "description": "Leave null to use the original event's value", "nullable": true }, "UrlKey": { "maxLength": 50, "minLength": 0, "pattern": "^[0-9A-Za-z_\\-]+$", "type": "string" }, "AccountingCode": { "type": "string", "nullable": true }, "LocationName": { "type": "string", "description": "Leave null to use the original event's value", "nullable": true }, "LocationDetails": { "type": "string", "description": "Leave null to use the original event's value", "nullable": true }, "Street": { "type": "string", "description": "Leave null to use the original event's value", "nullable": true }, "City": { "type": "string", "description": "Leave null to use the original event's value", "nullable": true }, "Region": { "type": "string", "description": "Leave null to use the original event's value", "nullable": true }, "Country": { "type": "string", "description": "Leave null to use the original event's value", "nullable": true }, "PostalCode": { "type": "string", "description": "Leave null to use the original event's value", "nullable": true }, "Coordinates": { "type": "string", "description": "Leave null to use the original event's value", "nullable": true }, "UseMap": { "type": "boolean", "nullable": true }, "MapAddress": { "type": "string", "description": "Leave null to use the original event's value", "nullable": true }, "Dates": { "type": "array", "items": { "$ref": "#/components/schemas/EventDateCreateInput" }, "description": "Leave null to use the original event's value", "nullable": true }, "TimeZoneId": { "type": "string", "description": "Leave null to use the original event's value", "nullable": true }, "CategoryId": { "type": "integer", "description": "Leave null to use the original event's value", "format": "int32", "nullable": true }, "OverallCapacity": { "type": "integer", "format": "int32", "nullable": true }, "PaymentProfileId": { "type": "string", "description": "Leave null to use the original event's value", "nullable": true }, "CopyReports": { "type": "boolean" }, "CopyCheckinOptions": { "type": "boolean" }, "CopyGroups": { "type": "boolean" }, "CopyWebhooks": { "type": "boolean" }, "CopySubscriptions": { "type": "boolean" }, "CopyAccessCodes": { "type": "boolean" }, "CopyCommunities": { "type": "boolean" }, "CopyEmails": { "type": "boolean" }, "CopyPromoCodes": { "type": "boolean" }, "CopyPrintJobs": { "type": "boolean" }, "CopySeatLayoutId": { "type": "string", "description": "This is only if the source event is AST. This is either an event id, or layout id. Leave null to use the original event's value", "nullable": true }, "CopyThemeEventId": { "type": "string", "description": "Leave null to use the original event's value", "nullable": true }, "CopyFees": { "$ref": "#/components/schemas/CopyFeesType" } }, "additionalProperties": false }, "EventCreateInput": { "required": [ "AccessKey", "CategoryId", "ClientId", "OrganizerEmail", "TimeZoneId", "Title", "UrlKey" ], "type": "object", "properties": { "AccessKey": { "minLength": 1, "type": "string", "description": "Your account access key. This is used to authenticate your requests." }, "ClientId": { "type": "string", "description": "The unique identifier for the client or organization that owns the event.", "format": "uuid", "example": "24134460-e7ce-4bbd-bed8-df11cdd20d75" }, "Title": { "minLength": 1, "type": "string", "description": "Event title", "example": "My New Event" }, "Subtitle": { "type": "string", "nullable": true }, "UrlKey": { "maxLength": 50, "minLength": 0, "pattern": "^[0-9A-Za-z_\\-]+$", "type": "string", "description": "Url Keys help you group similar events and customize the event url", "example": "summer2025" }, "EventCode": { "pattern": "^[0-9A-Za-z]+$", "type": "string", "description": "Event code for the event.", "nullable": true, "example": "EVT2025" }, "VerbiageSetting": { "$ref": "#/components/schemas/EventVerbiage" }, "CategoryId": { "type": "integer", "description": "3 - CAMP, 23 - CLASS, SEMINAR OR TRAINING, 14 - CONCERT, PERFORMANCE, PRODUCTION, 5 - CONFERENCE, 12 - OTHER", "format": "int32", "example": 3 }, "OverallCapacity": { "type": "integer", "description": "How many people do you expect to attend this event?", "format": "int32", "nullable": true }, "EventType": { "$ref": "#/components/schemas/EventType" }, "IsCapacityManaged": { "type": "boolean", "description": "When this feature is enabled, a 15 minute timer ensures that all spots are held while they are in the cart. General admission events without this turned on will allow attendees to freely register and capacity will be managed at the point of placing an order instead of in the cart" }, "IsSticky": { "type": "boolean", "description": "Make this event sticky" }, "IsHidden": { "type": "boolean", "description": "Make this event private (only accessible via direct link)?" }, "HasTickets": { "type": "boolean", "description": "Enable Ticket links on confirmation emails?" }, "AccountingCode": { "type": "string", "description": "This value will appear on reports and will be sent to the payment gateway to help you reconcile.", "nullable": true }, "ShowRemaining": { "type": "boolean", "description": "If enabled, remaining tickets is shown to customers." }, "ShowSoldOut": { "type": "boolean", "description": "If a given option is not in a selected group, sold out, expired, or future, do you still want the options to appear so your customers know all available options?" }, "LockInGroups": { "type": "boolean", "description": "If this is enabled, all attendees who join a group will do so at the same type and rate that the group was created under. This \"locks in\" the price for all group members regardless of when they sign up." }, "TicketLimit": { "type": "integer", "format": "int32", "nullable": true }, "AttendeeChangeType": { "$ref": "#/components/schemas/AttendeeChangeType" }, "IsGroupCentric": { "type": "boolean", "description": "Enable \"Groups First\" functionality? (only works if group minimums are not enforced)" }, "IsGroupPrivate": { "type": "boolean", "description": "Group names should remain private? (only works if IsGroupCentric is true)" }, "SendEmails": { "type": "boolean" }, "AllowRefundDonation": { "type": "boolean", "description": "Allow tickets to be donated back into available inventory prior to start of event" }, "EventInfoTop": { "type": "string", "nullable": true }, "EventInfoBottom": { "type": "string", "nullable": true }, "StickyInfo": { "type": "string", "nullable": true }, "ConfirmationLogoImageUrl": { "type": "string", "description": "The logo that appears on the confirmation page and emails. Must be a valid media library reference. Image should be 1200px x 400px for proper display.", "nullable": true }, "ConfirmationText": { "type": "string", "nullable": true }, "PauseText": { "type": "string", "nullable": true }, "FinishText": { "type": "string", "nullable": true }, "GroupCentricText": { "type": "string", "description": "Only available for group centric events.", "nullable": true }, "GroupEmailText": { "type": "string", "nullable": true }, "AutoRegTC": { "type": "string", "nullable": true }, "AppImageUrl": { "type": "string", "description": "If supplied this will be used alongside the app interface in all modes. Image should be 1090px (wide) x 1870px (high) for proper display. Must be a valid media library reference.", "nullable": true }, "LocationName": { "type": "string", "nullable": true }, "LocationDetails": { "type": "string", "nullable": true }, "Street": { "type": "string", "nullable": true }, "City": { "type": "string", "nullable": true }, "Region": { "type": "string", "nullable": true }, "Country": { "type": "string", "nullable": true }, "PostalCode": { "type": "string", "nullable": true }, "Coordinates": { "type": "string", "nullable": true }, "UseMap": { "type": "boolean" }, "MapAddress": { "type": "string", "nullable": true }, "ContactPhone": { "pattern": "^((?:[\\.\\*\\(\\)\\-\\/\\s\\+]*\\d){10,})(.*)$", "type": "string", "description": "The phone number for the event contact person.", "nullable": true, "example": "+1-555-123-4567" }, "OrganizerEmail": { "minLength": 1, "pattern": "^([0-9A-Za-z\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff']+[-._+&])*[0-9A-Za-z\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff_']+@([-0-9A-Za-z\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff]+[.])+[a-zA-Z]{2,63}$", "type": "string", "description": "The email address for the event contact person.", "example": "organizer@example.com" }, "ManagerEmails": { "type": "array", "items": { "type": "string" }, "description": "Once daily, the address(es) provided here will receive an email with registration statistics and links to relevant reports for this event.", "nullable": true }, "NotifyEmails": { "type": "array", "items": { "type": "string" }, "description": "Each time an order is placed or a group notification email is sent, the address(es) provided here will be blind copied on the confirmation email. Separate multiple addresses with a comma.", "nullable": true }, "EventHomeUrl": { "pattern": "^(https\\:\\/\\/)[a-zA-Z0-9\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff\\-\\.]+\\.[a-zA-Z]{2,}(/\\S*)?$", "type": "string", "description": "Home URL for the event", "nullable": true, "example": "https://example.com" }, "Dates": { "type": "array", "items": { "$ref": "#/components/schemas/EventDateCreateInput" }, "nullable": true }, "PublishHideAt": { "type": "string", "format": "date-time", "nullable": true }, "PublishShowAt": { "type": "string", "format": "date-time", "nullable": true }, "TimeZoneId": { "minLength": 1, "type": "string" }, "AddonTitle": { "type": "string", "nullable": true }, "IsInclusiveTaxes": { "type": "boolean", "description": "When enabled, enter the total price including taxes. This price will be displayed as the inclusive price (including taxes and fees) and the tax amount will be calculated automatically for receipts and summaries. Once the event is created this may not be undone." }, "TaxRate": { "type": "number", "description": "Deprecated. Tax is now configured per-attendee-type via customFees; this field is accepted for backwards compatibility but ignored.", "format": "double" }, "OrderFeePercent": { "maximum": 100, "minimum": 0, "type": "number", "description": "These service fees are applied once per order, but are displayed in the inclusive fees on each attendee/add-on. They are assessed on the full price of each attendee/add-on inclusive of other fees, tax, discounts, or any other element of the cost, including this fee itself.\r\nDeprecated. Order-level fees have been removed; configure fees per-attendee-type via customFees; this field is accepted for backwards compatibility but ignored.", "format": "double" }, "AttendeeTypes": { "type": "array", "items": { "$ref": "#/components/schemas/EventAttendeeTypeCreateInput" }, "nullable": true }, "Addons": { "type": "array", "items": { "$ref": "#/components/schemas/EventAddonCreateInput" }, "nullable": true }, "SharedCapacities": { "type": "array", "items": { "$ref": "#/components/schemas/EventSharedCapacityCreateInput" }, "description": "These are your \"Time Slots\" if this is a time slot event.", "nullable": true }, "PaymentProfileId": { "type": "string", "format": "uuid", "nullable": true }, "CreditNumber": { "type": "integer", "description": "The default credit template to use when issuing credits for refunds or exchanges on this event. Leave null to use the organization-level default.", "format": "int64", "nullable": true }, "HeaderStyle": { "$ref": "#/components/schemas/EventHeaderStyle" }, "HeaderHtml": { "type": "string", "nullable": true }, "LogoUrl": { "pattern": "^(http(s?)\\:\\/\\/)?[a-zA-Z0-9\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff\\-\\.]+\\.[a-zA-Z]{2,}(/\\S*)?$", "type": "string", "description": "The logo image URL that appears for this event. Must be a valid media library reference.", "nullable": true, "example": "https://example.com" }, "LogoPosition": { "type": "string", "description": "Left, Center, or Right", "nullable": true }, "HeaderUrlLarge": { "pattern": "^(http(s?)\\:\\/\\/)?[a-zA-Z0-9\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff\\-\\.]+\\.[a-zA-Z]{2,}(/\\S*)?$", "type": "string", "description": "Only available for HeaderStyle.Banner", "nullable": true, "example": "https://example.com" }, "HeaderUrlMobile": { "pattern": "^(http(s?)\\:\\/\\/)?[a-zA-Z0-9\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff\\-\\.]+\\.[a-zA-Z]{2,}(/\\S*)?$", "type": "string", "description": "Only available for HeaderStyle.Banner", "nullable": true, "example": "https://example.com" }, "SiteBackgroundColor": { "type": "string", "description": "Hex color code for the background", "nullable": true }, "SiteBackgroundImageUrl": { "pattern": "^(http(s?)\\:\\/\\/)?[a-zA-Z0-9\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff\\-\\.]+\\.[a-zA-Z]{2,}(/\\S*)?$", "type": "string", "nullable": true, "example": "https://example.com" }, "SiteBackgroundSize": { "type": "string", "nullable": true }, "SiteBackgroundRepeat": { "type": "string", "description": "repeat, no-repeat, repeat-x, repeat-y", "nullable": true }, "SiteBackgroundAttachment": { "type": "string", "description": "scroll, fixed, local", "nullable": true }, "SiteBackgroundPosition": { "type": "string", "nullable": true }, "SiteBackgroundColorText": { "type": "string", "nullable": true }, "SiteLinkColor": { "type": "string", "nullable": true }, "BlockedAccounts": { "type": "array", "items": { "type": "string" }, "description": "Would you like to block certain accounts from seeing this event? If so, provide a list of account emails to block.", "nullable": true }, "AllowedAccounts": { "type": "array", "items": { "type": "string" }, "description": "Do you need to white list certain accounts to allow them to see this event? If so, provide a list of account emails to allow.", "nullable": true }, "GoogleAnalytics": { "type": "array", "items": { "$ref": "#/components/schemas/EventGoogleAnalyticsCreateInput" }, "nullable": true }, "CustomCode": { "type": "string", "description": "Manage role only\r\nThis code will be executed in the body of every front-facing page related to this event.\r\nJavascript must be enclosed in script tags and CSS must be enclosed in style tags.", "nullable": true }, "CustomCodeHead": { "type": "string", "description": "Manage role only\r\nThis code will be placed once in the head of every front-facing page related to this event.\r\nJavascript must be enclosed in script tags and CSS must be enclosed in style tags.", "nullable": true }, "CustomTracking": { "type": "string", "description": "Manage role only\r\nValues are per event: {0} = Order Total, {1} = Order Quantity, {2} = Order Number, {3} = Event Number, {4} = Event Title, {5} = Order Email, {6} = First Name, {7} = Last Name\r\nThis code will be exectuted ONLY on a successful order result.", "nullable": true }, "ParentEventId": { "type": "string", "description": "A parent is an event that is required in order to register for this event. If you give this event a parent, it will not appear in your store front. It will only be offered to people who purchase the parent.", "format": "uuid", "nullable": true }, "PreRegEventId": { "type": "string", "description": "When pre-registering via the app or the specialized web interface, attendees can load information from a past event to quickly register. Selecting an event below allows that link to happen without the end-user explicitly specifying the target event (this event). Even if nothing is selected below, auto-registration is available for any event.", "format": "uuid", "nullable": true }, "WidgetBuyFlowUrl": { "pattern": "^(http(s?)\\:\\/\\/)?[a-zA-Z0-9\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff\\-\\.]+\\.[a-zA-Z]{2,}(/\\S*)?$", "type": "string", "description": "If you are using our embeddable widget, we can redirect attendees to your page instead of Brushfire pages to keep their experience consistent.", "nullable": true, "example": "https://example.com" }, "WidgetPostAttendeeUrl": { "pattern": "^(http(s?)\\:\\/\\/)?[a-zA-Z0-9\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff\\-\\.]+\\.[a-zA-Z]{2,}(/\\S*)?$", "type": "string", "description": "If you are using our embeddable widget, we can redirect attendees to your page instead of Brushfire pages to keep their experience consistent.", "nullable": true, "example": "https://example.com" }, "AttendeeFields": { "type": "array", "items": { "$ref": "#/components/schemas/EventAttendeeFieldCreateInput" }, "description": "By default, all attendee fields will be connected to all attendee types.", "nullable": true }, "BuyerFields": { "type": "array", "items": { "$ref": "#/components/schemas/EventFieldCreateInput" }, "nullable": true }, "GroupFields": { "type": "array", "items": { "$ref": "#/components/schemas/EventGroupFieldCreateInput" }, "nullable": true }, "TicketField1Header": { "type": "string", "description": "This is the header label value for the custom ticket field.", "nullable": true }, "TicketField1Label": { "type": "string", "description": "Do you need more information on your tickets? You can use any standard field like \"Attendee Number\" or use one of your attendee/buyer/group field labels.", "nullable": true }, "TicketField2Header": { "type": "string", "description": "This is the header label value for the custom ticket field.", "nullable": true }, "TicketField2Label": { "type": "string", "description": "Do you need more information on your tickets? You can use any standard field like \"Attendee Number\" or use one of your attendee/buyer/group field labels.", "nullable": true }, "TicketField3Header": { "type": "string", "description": "This is the header label value for the custom ticket field.", "nullable": true }, "TicketField3Label": { "type": "string", "description": "Do you need more information on your tickets? You can use any standard field like \"Attendee Number\" or use one of your attendee/buyer/group field labels.", "nullable": true }, "TicketImageUrl": { "type": "string", "description": "Do you need a custom header image for your tickets? Image should be 1125px x 294px @216dpi for proper display. Must be a valid media library reference.", "nullable": true }, "TicketBackgroundColor": { "type": "string", "description": "Custom background color for your tickets. This should be a valid hex color code (e.g., #FFFFFF for white).", "nullable": true }, "TicketNotes": { "type": "string", "nullable": true }, "TicketAdImageUrl": { "type": "string", "description": "Image should be 2250px x 1125px @ 300dpi (7.5in x 3.75in) for proper display. Must be a valid media library reference.", "nullable": true }, "ExternalCustomersConfig": { "$ref": "#/components/schemas/EventExternalCustomersCreateInput" }, "OfferSpot": { "type": "boolean", "description": "Whether to offer Spot refund insurance for this event." } }, "additionalProperties": false }, "EventDateCreateInput": { "type": "object", "properties": { "StartsAt": { "type": "string", "format": "date-time" }, "EndsAt": { "type": "string", "format": "date-time", "nullable": true }, "DoorsAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "EventDateItem": { "type": "object", "properties": { "DoorsAt": { "type": "string", "format": "date-time", "nullable": true }, "StartsAt": { "type": "string", "format": "date-time" }, "EndsAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "EventDateOutput": { "type": "object", "properties": { "DoorsAt": { "type": "string", "format": "date-time", "nullable": true }, "StartsAt": { "type": "string", "format": "date-time" }, "EndsAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "EventDetailsOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "EventNumber": { "type": "integer", "format": "int64" }, "PreRegParentId": { "type": "string", "format": "uuid", "nullable": true }, "PreRegChildId": { "type": "string", "format": "uuid", "nullable": true }, "UrlKey": { "type": "string", "nullable": true }, "ClientKey": { "type": "string", "nullable": true }, "ClientName": { "type": "string", "nullable": true }, "ClientCountry": { "type": "string", "nullable": true }, "ClientRegion": { "type": "string", "nullable": true }, "ClientIsDemo": { "type": "boolean" }, "PaymentProfileId": { "type": "string", "format": "uuid", "nullable": true }, "ClientTheme": { "type": "string", "nullable": true }, "EventTheme": { "type": "string", "nullable": true }, "AppImageUrl": { "type": "string", "nullable": true }, "IsAssigned": { "type": "boolean" }, "HasCommunities": { "type": "boolean" }, "HasExistingGroups": { "type": "boolean" }, "HasGroupTypes": { "type": "boolean" }, "LockinGroups": { "type": "boolean" }, "IsGroupCentric": { "type": "boolean" }, "IsGroupPrivate": { "type": "boolean" }, "GroupCentricText": { "type": "string", "nullable": true }, "ShowSoldOut": { "type": "boolean" }, "HasActiveEventCodes": { "type": "boolean" }, "HasActiveSeatCodes": { "type": "boolean" }, "HasActiveTypeCodes": { "type": "boolean" }, "HasPayments": { "type": "boolean" }, "PromoImageUrl": { "type": "string", "nullable": true }, "PromoDescription": { "type": "string", "nullable": true }, "AccessState": { "type": "string", "nullable": true }, "AccessMessage": { "type": "string", "nullable": true }, "PreventChanges": { "type": "boolean" }, "AccessCodeIsValid": { "type": "boolean" }, "PauseText": { "type": "string", "nullable": true }, "CategoryId": { "type": "integer", "format": "int32" }, "CategoryName": { "type": "string", "nullable": true }, "UseMap": { "type": "boolean" }, "LocationName": { "type": "string", "nullable": true }, "Street": { "type": "string", "nullable": true }, "City": { "type": "string", "nullable": true }, "Region": { "type": "string", "nullable": true }, "Country": { "type": "string", "nullable": true }, "PostalCode": { "type": "string", "nullable": true }, "LocationDetails": { "type": "string", "nullable": true }, "MapAddress": { "type": "string", "nullable": true }, "Address": { "type": "string", "nullable": true }, "Location": { "type": "string", "nullable": true }, "Latitude": { "type": "number", "format": "double" }, "Longitude": { "type": "number", "format": "double" }, "TimeZoneId": { "type": "string", "nullable": true }, "Culture": { "type": "string", "nullable": true }, "Currency": { "type": "string", "nullable": true }, "ShareUrl": { "type": "string", "nullable": true }, "FacebookUrl": { "type": "string", "nullable": true }, "TwitterUrl": { "type": "string", "nullable": true }, "TwitterRelated": { "type": "string", "nullable": true }, "TwitterText": { "type": "string", "nullable": true }, "SessionCount": { "type": "integer", "format": "int32" }, "Title": { "type": "string", "nullable": true }, "AlternateTitle": { "type": "string", "nullable": true, "readOnly": true }, "TitleInfo": { "type": "string", "nullable": true }, "Subtitle": { "type": "string", "nullable": true }, "IsPublished": { "type": "boolean" }, "IsHidden": { "type": "boolean" }, "OverallCapacity": { "type": "integer", "format": "int32", "nullable": true }, "IsSoldOut": { "type": "boolean" }, "SpotsTaken": { "type": "integer", "format": "int32", "nullable": true }, "SpotsRemaining": { "type": "integer", "format": "int32", "nullable": true }, "Types": { "type": "array", "items": { "$ref": "#/components/schemas/EventTypeOutput" }, "nullable": true }, "Verbiage": { "type": "string", "nullable": true }, "Dates": { "type": "array", "items": { "$ref": "#/components/schemas/EventDateOutput" }, "nullable": true }, "DateInfoList": { "type": "array", "items": { "type": "string" }, "nullable": true }, "DateInfo": { "type": "string", "nullable": true }, "StartsAt": { "type": "string", "format": "date-time", "nullable": true }, "DoorsAt": { "type": "string", "format": "date-time", "nullable": true }, "EndsAt": { "type": "string", "format": "date-time", "nullable": true }, "HasParent": { "type": "boolean" }, "VenueImage": { "type": "string", "nullable": true }, "EventInfoTop": { "type": "string", "nullable": true }, "EventInfoBottom": { "type": "string", "nullable": true }, "StickyInfo": { "type": "string", "nullable": true }, "EventCode": { "type": "string", "nullable": true }, "ContactPhone": { "type": "string", "nullable": true }, "ContactEmail": { "type": "string", "nullable": true }, "Website": { "type": "string", "nullable": true }, "CreatedAt": { "type": "string", "format": "date-time" }, "SeasonRunAt": { "type": "string", "format": "date-time", "nullable": true }, "IsSeasonMaster": { "type": "boolean" }, "IsSeasonChild": { "type": "boolean" }, "IsSeasonRunImmediate": { "type": "boolean" }, "Sessions": { "type": "array", "items": { "$ref": "#/components/schemas/EventSessionOutput" }, "nullable": true }, "Documents": { "$ref": "#/components/schemas/EventDocumentOutput" }, "StreamUrl": { "type": "string", "nullable": true }, "PublishShowAt": { "type": "string", "format": "date-time", "nullable": true }, "PublishHideAt": { "type": "string", "format": "date-time", "nullable": true }, "AutoRegTC": { "type": "string", "nullable": true }, "AreaName": { "type": "string", "nullable": true }, "AreaKey": { "type": "string", "nullable": true }, "AreaHeaderLogo": { "type": "string", "nullable": true }, "AreaHeaderHtml": { "type": "string", "nullable": true }, "AcctCode": { "type": "string", "nullable": true }, "ShowStage": { "type": "boolean" }, "RelatedEvents": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedEventOutput" }, "nullable": true }, "IsFlexPass": { "type": "boolean" }, "IsTimeSlot": { "type": "boolean" }, "TaxLabel": { "type": "string", "nullable": true }, "AddonTitle": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EventDocumentOutput": { "type": "object", "properties": { "HasTicket": { "type": "boolean" }, "HasETicket": { "type": "boolean" }, "HasReceipt": { "type": "boolean" }, "HasNamebadge": { "type": "boolean" }, "HasCheckIn": { "type": "boolean" }, "HasWillCallLabel": { "type": "boolean" }, "HasMailLabel": { "type": "boolean" } }, "additionalProperties": false }, "EventExternalCustomersCreateInput": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "WHether Brushfire should attempt to find/create customersin Square for this event." }, "customerGroups": { "type": "array", "items": { "type": "string" }, "description": "A list of Square Customer Group IDs - if provided, Square Customers for this event will be added to all of these groups.", "nullable": true }, "overwriteProfile": { "type": "boolean", "description": "If true, any personal data collected during checkout will overwrite existing customer data in Square. If false, personal data will be added, but existing Square data will not be overwritten." } }, "additionalProperties": false }, "EventFieldCreateInput": { "type": "object", "properties": { "Label": { "type": "string", "nullable": true }, "FieldType": { "$ref": "#/components/schemas/FieldType" }, "ValidationExpression": { "type": "string", "nullable": true }, "StoredValue": { "type": "string", "nullable": true }, "Notes": { "type": "string", "nullable": true }, "AdminRequired": { "type": "boolean" }, "AdminVisible": { "type": "boolean" }, "InternetRequired": { "type": "boolean" }, "InternetVisible": { "type": "boolean" }, "IsSensitive": { "type": "boolean" }, "Options": { "type": "array", "items": { "$ref": "#/components/schemas/EventFieldOptionCreateInput" }, "description": "Only set for fields of type Checkbox, Dropdown, Radiobuttons, ItemList, or ItemAmount", "nullable": true }, "RemoteUrl": { "type": "string", "description": "Only set for fields of type RemoteFetch or RemoteValidate", "nullable": true }, "RequireConfirm": { "type": "boolean", "description": "Only set for fields of type Text, Name, Phone, Email, or Date" }, "EmailDomains": { "type": "array", "items": { "type": "string" }, "description": "The list of domains you would like to validate for or against for email fields.", "nullable": true }, "DomainValidation": { "$ref": "#/components/schemas/DomainValidationType" } }, "additionalProperties": false }, "EventFieldOptionCreateInput": { "type": "object", "properties": { "Label": { "type": "string", "nullable": true }, "IsSelected": { "type": "boolean" }, "AdminVisible": { "type": "boolean" }, "InternetVisible": { "type": "boolean" }, "Custom1": { "type": "string", "nullable": true }, "UnitPrice": { "type": "number", "format": "double", "nullable": true }, "Capacity": { "type": "integer", "format": "int32", "nullable": true }, "DependentFields": { "type": "array", "items": { "$ref": "#/components/schemas/EventFieldCreateInput" }, "description": "Use this to create fields that are only visible when this option is selected", "nullable": true } }, "additionalProperties": false }, "EventGoogleAnalyticsCreateInput": { "type": "object", "properties": { "number": { "pattern": "^((UA|G)-[-0-9A-Za-z]{4,50})+$", "type": "string", "description": "The Google Analytics tracking number for the event.", "nullable": true, "example": "UA-12345678-1" }, "domain": { "type": "string", "description": "The Google Analytics domain", "nullable": true } }, "additionalProperties": false }, "EventGroupFieldCreateInput": { "type": "object", "properties": { "IsGroup": { "type": "boolean", "readOnly": true }, "Label": { "type": "string", "nullable": true }, "FieldType": { "$ref": "#/components/schemas/FieldType" }, "ValidationExpression": { "type": "string", "nullable": true }, "StoredValue": { "type": "string", "nullable": true }, "Notes": { "type": "string", "nullable": true }, "AdminRequired": { "type": "boolean" }, "AdminVisible": { "type": "boolean" }, "InternetRequired": { "type": "boolean" }, "InternetVisible": { "type": "boolean" }, "IsSensitive": { "type": "boolean" }, "Options": { "type": "array", "items": { "$ref": "#/components/schemas/EventFieldOptionCreateInput" }, "description": "Only set for fields of type Checkbox, Dropdown, Radiobuttons, ItemList, or ItemAmount", "nullable": true }, "RemoteUrl": { "type": "string", "description": "Only set for fields of type RemoteFetch or RemoteValidate", "nullable": true }, "RequireConfirm": { "type": "boolean", "description": "Only set for fields of type Text, Name, Phone, Email, or Date" }, "EmailDomains": { "type": "array", "items": { "type": "string" }, "description": "The list of domains you would like to validate for or against for email fields.", "nullable": true }, "DomainValidation": { "$ref": "#/components/schemas/DomainValidationType" } }, "additionalProperties": false }, "EventHeaderStyle": { "enum": [ "HTML", "Banner", "Logo" ], "type": "string" }, "EventListOutput": { "type": "object", "properties": { "Title": { "type": "string", "nullable": true }, "Subtitle": { "type": "string", "nullable": true }, "UrlKey": { "type": "string", "nullable": true }, "ClientKey": { "type": "string", "nullable": true }, "ClientName": { "type": "string", "nullable": true }, "Culture": { "type": "string", "nullable": true }, "DateInfo": { "type": "string", "nullable": true }, "DateInfoList": { "type": "array", "items": { "type": "string" }, "nullable": true }, "SoldOut": { "type": "boolean" }, "IsSticky": { "type": "boolean" }, "EventNumber": { "type": "integer", "format": "int64" }, "IsAssigned": { "type": "boolean" }, "LocationName": { "type": "string", "nullable": true }, "SessionCount": { "type": "integer", "format": "int32" }, "IsActive": { "type": "boolean" }, "DateDisplay": { "$ref": "#/components/schemas/DateDisplayOutput" }, "Latitude": { "type": "number", "format": "double" }, "Longitude": { "type": "number", "format": "double" }, "MapUrl": { "type": "string", "nullable": true }, "PromoImageUrl": { "type": "string", "nullable": true }, "CategoryId": { "type": "integer", "format": "int32" }, "CategoryName": { "type": "string", "nullable": true }, "SpotsRemaining": { "type": "integer", "format": "int32", "nullable": true }, "SpotsTaken": { "type": "integer", "format": "int32" }, "ShowRemaining": { "type": "boolean" }, "RemainingText": { "type": "string", "nullable": true }, "Verbiage": { "type": "string", "nullable": true }, "Dates": { "type": "array", "items": { "$ref": "#/components/schemas/EventDateOutput" }, "nullable": true }, "AlternateTitle": { "type": "string", "nullable": true, "readOnly": true }, "TimeZoneId": { "type": "string", "nullable": true }, "AreaName": { "type": "string", "nullable": true }, "AreaKey": { "type": "string", "nullable": true }, "PaymentProfileId": { "type": "string", "format": "uuid", "nullable": true }, "AcctCode": { "type": "string", "nullable": true }, "IsHidden": { "type": "boolean" }, "IsFlexPass": { "type": "boolean" }, "IsExchangeable": { "type": "boolean" } }, "additionalProperties": false }, "EventMoveInput": { "required": [ "AccessKey", "TargetClientId", "UrlKey" ], "type": "object", "properties": { "AccessKey": { "minLength": 1, "type": "string", "description": "Your account access key. This is used to authenticate your requests." }, "TargetClientId": { "type": "string", "description": "The ID of the client to move the event to.", "format": "uuid" }, "UrlKey": { "maxLength": 50, "minLength": 0, "pattern": "^[0-9A-Za-z_\\-]+$", "type": "string", "description": "The URL key the event will have under the target client." }, "PaymentProfileId": { "type": "string", "description": "The payment profile ID to assign to the event in the target client. Leave null to assign no payment profile.", "format": "uuid", "nullable": true }, "UseNewClientFeeStructure": { "type": "boolean", "description": "Whether to replace the event's fee structure with the target client's fee structure. Defaults to true.\r\nSetting this to false is restricted to Brushfire staff." } }, "additionalProperties": false }, "EventPaymentMethodOutput": { "type": "object", "properties": { "Grouping": { "type": "string", "nullable": true }, "Id": { "type": "string", "format": "uuid" }, "Name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EventResourceOutput": { "type": "object", "properties": { "Category": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "Url": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EventSeatOutput": { "type": "object", "properties": { "SeatId": { "type": "string", "format": "uuid" }, "SectionId": { "type": "string", "format": "uuid" }, "SectionName": { "type": "string", "nullable": true }, "EventId": { "type": "string", "format": "uuid" }, "EventNumber": { "type": "integer", "format": "int64" }, "RowName": { "type": "string", "nullable": true }, "SeatNumber": { "type": "integer", "format": "int32" }, "SeatLabel": { "type": "string", "nullable": true }, "SeatType": { "type": "string", "nullable": true }, "Wheelchair": { "type": "boolean" }, "LimitedView": { "type": "boolean" }, "Distanced": { "type": "boolean" }, "UnitPrice": { "type": "number", "format": "double" }, "PriceColor": { "$ref": "#/components/schemas/ColorOutput" }, "Available": { "type": "boolean" }, "ReservedAt": { "type": "string", "format": "date-time", "nullable": true }, "Notes": { "type": "string", "nullable": true }, "OrderId": { "type": "string", "format": "uuid", "nullable": true }, "OrderKey": { "type": "string", "nullable": true }, "AttendeeId": { "type": "string", "format": "uuid", "nullable": true }, "AttendeeNumber": { "type": "integer", "format": "int64", "nullable": true }, "State": { "$ref": "#/components/schemas/SeatReservedStateOutput" }, "InaccessibleDueToAccessCode": { "type": "boolean" }, "Types": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "Amounts": { "type": "array", "items": { "type": "number", "format": "double" }, "nullable": true } }, "additionalProperties": false }, "EventSectionOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Name": { "type": "string", "nullable": true }, "Alignment": { "type": "string", "nullable": true }, "AislesAfter": { "type": "array", "items": { "type": "string" }, "nullable": true }, "IsRowAscending": { "type": "boolean" }, "IsSeatAscending": { "type": "boolean" }, "IsRankAscending": { "type": "boolean" }, "IsAssigned": { "type": "boolean" }, "Rotation": { "type": "integer", "format": "int32" }, "Rank": { "type": "integer", "format": "int32" }, "DistanceCount": { "type": "integer", "format": "int32" }, "RemainingText": { "type": "string", "nullable": true }, "SpotsRemaining": { "type": "integer", "format": "int32", "nullable": true }, "PriceBreakdown": { "type": "array", "items": { "$ref": "#/components/schemas/EventSectionPriceOutput" }, "nullable": true }, "ReservedStates": { "type": "array", "items": { "$ref": "#/components/schemas/EventSectionReservedStateOutput" }, "nullable": true } }, "additionalProperties": false }, "EventSectionPriceOutput": { "type": "object", "properties": { "TypeId": { "type": "string", "format": "uuid" }, "Amount": { "type": "number", "format": "double" }, "Fee": { "type": "number", "format": "double", "nullable": true }, "IsInclusiveFees": { "type": "boolean" }, "ConsecutiveSeats": { "type": "integer", "format": "int32" }, "DisplayAmount": { "type": "number", "format": "double" }, "PriceDescription": { "type": "string", "nullable": true }, "CustomFees": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFeeOutput" }, "nullable": true } }, "additionalProperties": false }, "EventSectionReservedStateOutput": { "type": "object", "properties": { "ReservedState": { "$ref": "#/components/schemas/SeatReservedStateOutput" }, "SeatCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "EventSessionOutput": { "type": "object", "properties": { "SessionNumber": { "type": "integer", "format": "int64" }, "Name": { "type": "string", "nullable": true }, "AttendeeTotal": { "type": "integer", "format": "int32" }, "CheckedInCount": { "type": "integer", "format": "int32" }, "Type": { "type": "string", "nullable": true }, "IsHidden": { "type": "boolean" }, "AllowFlex": { "type": "boolean", "nullable": true }, "FlexPassCount": { "type": "integer", "format": "int32" }, "FlexAttendeeTotal": { "type": "integer", "format": "int32" }, "IsTimeSlot": { "type": "boolean" }, "MinutesBefore": { "type": "integer", "format": "int32" }, "MinutesAfter": { "type": "integer", "format": "int32" }, "AllowPasses": { "type": "boolean" } }, "additionalProperties": false }, "EventSharedCapacityCreateInput": { "type": "object", "properties": { "SharedCapacityName": { "type": "string", "description": "For time slot events, if the SharedCapacityKind is \"Time\", you must provide a time here. i.e. \"10:00 AM\".", "nullable": true }, "SharedCapacity": { "type": "integer", "format": "int32", "nullable": true }, "SharedCapacityKind": { "$ref": "#/components/schemas/SharedCapacityKind" }, "IsHidden": { "type": "boolean", "description": "Only for time slot events. If true, attendee types connected to this shared capacity will not be visible." }, "ConnectedTypeNames": { "type": "array", "items": { "type": "string" }, "description": "List of attendee type names or addons names that are connected to this shared capacity. Must not mix and match. Time Slot events allow for attendee types to be connected across multiple shared capacities.", "nullable": true } }, "additionalProperties": false }, "EventSingleOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "EventNumber": { "type": "integer", "format": "int64" }, "UrlKey": { "type": "string", "nullable": true }, "ClientKey": { "type": "string", "nullable": true }, "ClientName": { "type": "string", "nullable": true }, "ClientIsDemo": { "type": "boolean" }, "IsAssigned": { "type": "boolean" }, "CategoryId": { "type": "integer", "format": "int32" }, "CategoryName": { "type": "string", "nullable": true }, "UseMap": { "type": "boolean" }, "LocationName": { "type": "string", "nullable": true }, "Street": { "type": "string", "nullable": true }, "City": { "type": "string", "nullable": true }, "Region": { "type": "string", "nullable": true }, "Country": { "type": "string", "nullable": true }, "PostalCode": { "type": "string", "nullable": true }, "LocationDetails": { "type": "string", "nullable": true }, "MapAddress": { "type": "string", "nullable": true }, "Address": { "type": "string", "nullable": true }, "Location": { "type": "string", "nullable": true }, "ShowSoldOut": { "type": "boolean" }, "PaymentProfileId": { "type": "string", "format": "uuid", "nullable": true }, "TimeZoneId": { "type": "string", "nullable": true }, "Culture": { "type": "string", "nullable": true }, "Currency": { "type": "string", "nullable": true }, "FacebookUrl": { "type": "string", "nullable": true }, "SessionCount": { "type": "integer", "format": "int32" }, "Title": { "type": "string", "nullable": true }, "AlternateTitle": { "type": "string", "nullable": true, "readOnly": true }, "TitleInfo": { "type": "string", "nullable": true }, "Subtitle": { "type": "string", "nullable": true }, "IsPublished": { "type": "boolean" }, "OverallCapacity": { "type": "integer", "format": "int32", "nullable": true }, "IsSoldOut": { "type": "boolean" }, "SpotsTaken": { "type": "integer", "format": "int32", "nullable": true }, "SpotsRemaining": { "type": "integer", "format": "int32", "nullable": true }, "IsHidden": { "type": "boolean" }, "Verbiage": { "type": "string", "nullable": true }, "Dates": { "type": "array", "items": { "$ref": "#/components/schemas/EventDateOutput" }, "nullable": true }, "DateInfoList": { "type": "array", "items": { "type": "string" }, "nullable": true }, "DateInfo": { "type": "string", "nullable": true }, "StartsAt": { "type": "string", "format": "date-time", "nullable": true }, "DoorsAt": { "type": "string", "format": "date-time", "nullable": true }, "EndsAt": { "type": "string", "format": "date-time", "nullable": true }, "HasParent": { "type": "boolean" }, "VenueImage": { "type": "string", "nullable": true }, "EventInfoTop": { "type": "string", "nullable": true }, "EventInfoBottom": { "type": "string", "nullable": true }, "StickyInfo": { "type": "string", "nullable": true }, "EventCode": { "type": "string", "nullable": true }, "ContactPhone": { "type": "string", "nullable": true }, "ContactEmail": { "type": "string", "nullable": true }, "Website": { "type": "string", "nullable": true }, "CreatedAt": { "type": "string", "format": "date-time" }, "SeasonRunAt": { "type": "string", "format": "date-time", "nullable": true }, "IsSeasonMaster": { "type": "boolean" }, "IsSeasonChild": { "type": "boolean" }, "IsSeasonRunImmediate": { "type": "boolean" }, "AppImageUrl": { "type": "string", "nullable": true }, "StreamUrl": { "type": "string", "nullable": true }, "AreaName": { "type": "string", "nullable": true }, "AreaKey": { "nullable": true }, "AcctCode": { "type": "string", "nullable": true }, "ShowStage": { "type": "boolean" }, "IsFlexPass": { "type": "boolean" }, "AttendeeChanges": { "$ref": "#/components/schemas/AttendeeChangeType" }, "IsTimeSlot": { "type": "boolean" }, "AddonTitle": { "type": "string", "nullable": true }, "IsExchangeable": { "type": "boolean" } }, "additionalProperties": false }, "EventType": { "enum": [ "GeneralAdmission", "FlexPass", "TimeSlot" ], "type": "string" }, "EventTypeOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Name": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "IsAvailable": { "type": "boolean" }, "IsFuture": { "type": "boolean" }, "IsPast": { "type": "boolean" }, "Available": { "type": "string", "nullable": true }, "SelectedAmount": { "type": "number", "format": "double", "nullable": true }, "Amount": { "type": "number", "format": "double", "nullable": true }, "DisplayAmount": { "type": "number", "format": "double" }, "PriceDescription": { "type": "string", "nullable": true }, "Fee": { "type": "number", "description": "Deprecated. Fees are now set in CustomFees; this property is kept for backwards compatibility but should be ignored.", "format": "double" }, "Tax": { "type": "number", "description": "Deprecated. Taxes are now set in CustomFees; this property is kept for backwards compatibility but should be ignored.", "format": "double", "nullable": true }, "TaxRate": { "type": "number", "description": "Deprecated. Tax rates are now set in CustomFees; this property is kept for backwards compatibility but should be ignored.", "format": "double", "nullable": true }, "OrderFeePercent": { "type": "number", "description": "Deprecated. Fees are now set in CustomFees; this property is kept for backwards compatibility but should be ignored.", "format": "double", "nullable": true }, "IsInclusiveFees": { "type": "boolean" }, "IsInclusiveTaxes": { "type": "boolean" }, "AllowCustomAmount": { "type": "boolean" }, "PreRegEnabled": { "type": "boolean" }, "GiftingEnabled": { "type": "boolean" }, "CopyEnabled": { "type": "boolean" }, "AcctCode": { "type": "string", "nullable": true }, "PaymentAmounts": { "type": "string", "nullable": true }, "PaymentsDueBy": { "type": "string", "nullable": true }, "MinQuantity": { "type": "integer", "format": "int32" }, "MaxQuantity": { "type": "integer", "format": "int32", "nullable": true }, "IsGroup": { "type": "boolean" }, "SoldOut": { "type": "boolean" }, "YourGroup": { "type": "boolean" }, "GroupingText": { "type": "string", "nullable": true }, "QuantityRequirements": { "type": "string", "nullable": true }, "GroupRequirements": { "type": "string", "nullable": true, "readOnly": true }, "IsInaccessibleDueToAccessCode": { "type": "boolean" }, "IsAccessibleBecauseOfAccessCode": { "type": "boolean" }, "IsAdmin": { "type": "boolean" }, "Kind": { "type": "string", "nullable": true }, "AllowedPayments": { "type": "array", "items": { "type": "number", "format": "double" }, "nullable": true }, "AllowedDisplayPayments": { "type": "array", "items": { "type": "number", "format": "double" }, "nullable": true }, "Sections": { "type": "array", "items": { "$ref": "#/components/schemas/EventTypeSectionOutput" }, "nullable": true }, "Prices": { "type": "array", "items": { "$ref": "#/components/schemas/EventTypePriceOutput" }, "nullable": true }, "SpotsRemaining": { "type": "integer", "format": "int32", "nullable": true }, "RemainingText": { "type": "string", "nullable": true }, "SharedCapacityId": { "type": "string", "format": "uuid", "nullable": true }, "SharedCapacityName": { "type": "string", "nullable": true }, "SharedCapacityKind": { "type": "string", "nullable": true }, "TimeSlotStartsAt": { "type": "string", "format": "date-time", "nullable": true }, "ShareEnabled": { "type": "boolean" }, "IsAddon": { "type": "boolean" }, "ImageUrl": { "type": "string", "nullable": true }, "GeneratesTicket": { "type": "boolean" }, "ExternalId": { "type": "string", "nullable": true }, "Variations": { "type": "array", "items": { "$ref": "#/components/schemas/EventTypeVariationOutput" }, "nullable": true }, "CustomFees": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFeeOutput" }, "nullable": true }, "FeeLineItems": { "type": "array", "items": { "$ref": "#/components/schemas/UnitFeeLineItemOutput" }, "nullable": true }, "FeeBreakdown": { "type": "array", "items": { "$ref": "#/components/schemas/UnitFeeLineItemOutput" }, "nullable": true, "readOnly": true }, "TaxBreakdown": { "type": "array", "items": { "$ref": "#/components/schemas/UnitFeeLineItemOutput" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "EventTypePriceOutput": { "type": "object", "properties": { "PriceId": { "type": "string", "format": "uuid" }, "Name": { "type": "string", "nullable": true }, "Color": { "type": "string", "nullable": true }, "BasePrice": { "type": "number", "format": "double" }, "Amount": { "type": "number", "format": "double" }, "Fee": { "type": "number", "format": "double" }, "Tax": { "type": "number", "format": "double" }, "IsInclusiveFees": { "type": "boolean" }, "IsInclusiveTaxes": { "type": "boolean" }, "DisplayAmount": { "type": "number", "format": "double" }, "PriceDescription": { "type": "string", "nullable": true }, "FeeLineItems": { "type": "array", "items": { "$ref": "#/components/schemas/UnitFeeLineItemOutput" }, "nullable": true }, "FeeBreakdown": { "type": "array", "items": { "$ref": "#/components/schemas/UnitFeeLineItemOutput" }, "nullable": true, "readOnly": true }, "TaxBreakdown": { "type": "array", "items": { "$ref": "#/components/schemas/UnitFeeLineItemOutput" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "EventTypeSectionOutput": { "type": "object", "properties": { "SectionId": { "type": "string", "format": "uuid" }, "SectionName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EventTypeVariationOutput": { "type": "object", "properties": { "ItemId": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "Price": { "type": "number", "format": "double" }, "DisplayPrice": { "type": "number", "format": "double", "nullable": true }, "PriceDescription": { "type": "string", "nullable": true }, "SpotsRemaining": { "type": "integer", "format": "int32", "nullable": true }, "RemainingText": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "EventVerbiage": { "enum": [ "Registrations", "Tickets" ], "type": "string" }, "ExchangeAttendeeOutput": { "type": "object", "properties": { "AttendeeId": { "type": "string", "format": "uuid" }, "AttendeeNumber": { "type": "integer", "format": "int64" }, "EventId": { "type": "string", "format": "uuid" }, "AttendeeTypeId": { "type": "string", "format": "uuid" }, "TypeName": { "type": "string", "nullable": true }, "Amount": { "type": "number", "format": "double" }, "Addons": { "type": "number", "format": "double" }, "Discounts": { "type": "number", "format": "double" }, "Fees": { "type": "number", "format": "double" }, "Taxes": { "type": "number", "format": "double" }, "Deliveries": { "type": "number", "description": "Deprecated. Delivery has been folded into API.Models.ExchangeAttendeeOutput.Fees; this property is kept for backwards compatibility but should be ignored.", "format": "double" }, "Status": { "type": "string", "nullable": true }, "IsCompleted": { "type": "boolean" }, "ExternalId": { "type": "string", "nullable": true }, "ExternalDescription": { "type": "string", "nullable": true }, "IsAddon": { "type": "boolean" }, "Total": { "type": "number", "format": "double", "readOnly": true } }, "additionalProperties": false }, "ExchangeInput": { "required": [ "AccessKey", "AttendeeNumbers", "ClientKey", "ExchangeMethod", "SourceEventId" ], "type": "object", "properties": { "ClientKey": { "minLength": 1, "type": "string" }, "AttendeeNumbers": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "ExchangeMethod": { "$ref": "#/components/schemas/ExchangeMethod" }, "AccessKey": { "minLength": 1, "type": "string" }, "SourceEventId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "ExchangeMethod": { "enum": [ "SameEvent", "NewEvent" ], "type": "string" }, "ExchangeOutput": { "type": "object", "properties": { "ExchangeId": { "type": "string", "format": "uuid" }, "ExchangeMethod": { "$ref": "#/components/schemas/ExchangeMethod" }, "ClientKey": { "type": "string", "nullable": true }, "ExchangeAttendees": { "type": "array", "items": { "$ref": "#/components/schemas/ExchangeAttendeeOutput" }, "nullable": true }, "LastModifiedAt": { "type": "string", "format": "date-time" }, "SourceEventId": { "type": "string", "format": "uuid" }, "IsExchangeRefundAllowed": { "type": "boolean" }, "ExchangeAttendeesTotal": { "type": "number", "format": "double", "readOnly": true } }, "additionalProperties": false }, "FeeItemType": { "enum": [ "Fee", "Tax" ], "type": "string" }, "FeeMethod": { "enum": [ "Pass", "Absorb" ], "type": "string" }, "FieldDisplayOutput": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Label": { "type": "string", "nullable": true }, "Value": { "type": "string", "nullable": true }, "Type": { "type": "string", "nullable": true }, "IsSensitive": { "type": "boolean" }, "OptionIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "FieldInput": { "required": [ "Id" ], "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Value": { "nullable": true } }, "additionalProperties": false }, "FieldMetaOutput": { "type": "object", "properties": { "FieldId": { "type": "string", "nullable": true }, "FieldName": { "type": "string", "nullable": true }, "Type": { "type": "string", "nullable": true }, "FieldType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FieldMetaType": { "enum": [ "Order", "Group", "Attendee" ], "type": "string" }, "FieldOptionFullOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Label": { "type": "string", "nullable": true }, "Capacity": { "type": "integer", "format": "int32", "nullable": true }, "Quantity": { "type": "integer", "format": "int32" }, "HasUnitPrice": { "type": "boolean" }, "UnitPrice": { "type": "number", "format": "double", "nullable": true }, "UnitTax": { "type": "number", "format": "double", "nullable": true }, "IsInclusiveTaxes": { "type": "boolean" }, "DisplayPrice": { "type": "number", "format": "double", "nullable": true }, "PriceDescription": { "type": "string", "nullable": true }, "IsSelected": { "type": "boolean" }, "HasCapacity": { "type": "boolean" }, "SpotsRemaining": { "type": "integer", "format": "int32", "nullable": true }, "RemainingText": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FieldOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Label": { "type": "string", "nullable": true }, "Type": { "type": "string", "nullable": true }, "Value": { "nullable": true }, "DisplayValue": { "type": "string", "nullable": true }, "ValidationExpression": { "type": "string", "nullable": true }, "IsRequired": { "type": "boolean" }, "Notes": { "type": "string", "nullable": true }, "ErrorMessage": { "type": "string", "nullable": true }, "IsDisabled": { "type": "boolean" }, "IsSensitive": { "type": "boolean" }, "SpecialFieldId": { "type": "string", "format": "uuid" }, "ParentOptionId": { "type": "string", "format": "uuid", "nullable": true }, "ParentFieldId": { "type": "string", "format": "uuid", "nullable": true }, "FormObjectId": { "type": "string", "format": "uuid", "nullable": true }, "Options": { "type": "array", "items": { "$ref": "#/components/schemas/FieldOptionFullOutput" }, "nullable": true }, "ParentOptionIsSelected": { "type": "boolean" }, "HasError": { "type": "boolean" }, "HasRelevantOutput": { "type": "boolean" }, "MinDate": { "type": "string", "format": "date-time", "nullable": true }, "MaxDate": { "type": "string", "format": "date-time", "nullable": true }, "AttendeeTypes": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "RemoteUrl": { "type": "string", "nullable": true }, "SelectedOptionId": { "type": "string", "format": "uuid", "nullable": true, "readOnly": true }, "Confirm": { "type": "boolean" }, "DomainValidation": { "$ref": "#/components/schemas/DomainValidationOutput" }, "DisplayIsPrimary": { "type": "boolean" } }, "additionalProperties": false }, "FieldType": { "enum": [ "Text", "MultiText", "Name", "Address", "Phone", "Email", "Dropdown", "Checkboxes", "Radiobuttons", "Date", "Accept", "ItemList", "ItemAmount", "Paragraph", "SectionHeader", "Link", "Signature", "RemoteValidate", "RemoteFetch" ], "type": "string" }, "FieldUpdateInput": { "type": "object", "properties": { "AccessKey": { "type": "string", "nullable": true }, "FieldValues": { "type": "array", "items": { "$ref": "#/components/schemas/FieldInput" }, "nullable": true }, "UpdateNewOnly": { "type": "boolean" } }, "additionalProperties": false }, "FieldUpdateType": { "enum": [ "Attendees", "Groups", "Buyer" ], "type": "string" }, "FlexPassCheckinItem": { "type": "object", "properties": { "EventId": { "type": "string", "format": "uuid" }, "EventNumber": { "type": "integer", "format": "int64" }, "Title": { "type": "string", "nullable": true }, "CheckedInAt": { "type": "string", "format": "date-time" }, "SessionName": { "type": "string", "nullable": true }, "AttendeeCheckinId": { "type": "string", "format": "uuid" }, "EventSessionId": { "type": "string", "format": "uuid" }, "SessionNumber": { "type": "integer", "format": "int64" }, "TimeZoneId": { "type": "string", "nullable": true }, "CheckedInAtLocal": { "type": "string", "format": "date-time", "readOnly": true }, "Culture": { "type": "string", "nullable": true }, "Dates": { "type": "array", "items": { "$ref": "#/components/schemas/EventDateItem" }, "nullable": true }, "StartsAt": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "TitleInfo": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "FormOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "ObjectId": { "type": "string", "format": "uuid" }, "IsAttendee": { "type": "boolean" }, "AttendeeNumber": { "type": "integer", "format": "int64", "nullable": true }, "IsPreRegistered": { "type": "boolean" }, "IsGift": { "type": "boolean" }, "ShareEmail": { "type": "string", "nullable": true }, "CopyEnabled": { "type": "boolean" }, "GiftingEnabled": { "type": "boolean" }, "PreRegEnabled": { "type": "boolean" }, "IsCopySource": { "type": "boolean" }, "IsCopyDestination": { "type": "boolean", "readOnly": true }, "CanContinue": { "type": "boolean" }, "AttendeeTypeId": { "type": "string", "format": "uuid" }, "AttendeeTypeName": { "type": "string", "nullable": true }, "IsCompleted": { "type": "boolean" }, "SeatId": { "type": "string", "format": "uuid", "nullable": true }, "SectionName": { "type": "string", "nullable": true }, "RowName": { "type": "string", "nullable": true }, "SeatLabel": { "type": "string", "nullable": true }, "DistanceCount": { "type": "integer", "format": "int32", "nullable": true }, "UnitPrice": { "type": "number", "format": "double" }, "UnitAddons": { "type": "number", "format": "double" }, "UnitFee": { "type": "number", "format": "double" }, "UnitTax": { "type": "number", "format": "double" }, "DisplayPrice": { "type": "number", "format": "double" }, "PriceDescription": { "type": "string", "nullable": true }, "IsInclusiveFees": { "type": "boolean" }, "IsInclusiveTaxes": { "type": "boolean" }, "Culture": { "type": "string", "nullable": true }, "CopyableAttendeeNumbers": { "type": "array", "items": { "type": "integer", "format": "int64" }, "nullable": true }, "DisplayName": { "type": "string", "nullable": true, "readOnly": true }, "AttendeeDisplay": { "type": "array", "items": { "type": "string" }, "nullable": true, "readOnly": true }, "Fields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldOutput" }, "nullable": true } }, "additionalProperties": false }, "GroupAttendeeSummaryOutput": { "type": "object", "properties": { "AttendeeNumber": { "type": "integer", "format": "int64" }, "AttendeeCode": { "type": "string", "nullable": true }, "FirstName": { "type": "string", "nullable": true }, "LastName": { "type": "string", "nullable": true }, "SectionName": { "type": "string", "nullable": true }, "RowName": { "type": "string", "nullable": true }, "SeatLabel": { "type": "string", "nullable": true }, "TypeName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GroupCommunityInput": { "type": "object", "properties": { "CommunityId": { "type": "string", "format": "uuid", "nullable": true }, "OverrideCapacity": { "type": "boolean" }, "DontFollowRules": { "type": "boolean" } }, "additionalProperties": false }, "GroupCreateInput": { "required": [ "AttendeeTypeId", "Email", "JoinCode", "Name" ], "type": "object", "properties": { "AttendeeTypeId": { "type": "string", "format": "uuid" }, "Name": { "maxLength": 50, "minLength": 5, "type": "string" }, "Email": { "maxLength": 100, "minLength": 0, "type": "string" }, "JoinCode": { "maxLength": 20, "minLength": 4, "type": "string" }, "AccessKey": { "type": "string", "nullable": true }, "CommunityId": { "type": "string", "format": "uuid", "nullable": true }, "FieldValues": { "type": "array", "items": { "$ref": "#/components/schemas/FieldInput" }, "nullable": true } }, "additionalProperties": false }, "GroupCreateOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "GroupNumber": { "type": "integer", "format": "int64" }, "Name": { "type": "string", "nullable": true }, "Email": { "type": "string", "nullable": true }, "AttendeeTypeId": { "type": "string", "format": "uuid" }, "JoinCode": { "type": "string", "nullable": true }, "TypeName": { "type": "string", "nullable": true }, "CommunityId": { "type": "string", "format": "uuid", "nullable": true }, "CommunityPartition": { "type": "string", "nullable": true }, "CommunityName": { "type": "string", "nullable": true }, "AttendeeCount": { "type": "integer", "format": "int32" }, "Fields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldOutput" }, "nullable": true } }, "additionalProperties": false }, "GroupHelpdeskOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "GroupNumber": { "type": "integer", "format": "int64" }, "Name": { "type": "string", "nullable": true }, "JoinCode": { "type": "string", "nullable": true }, "AttendeeCount": { "type": "integer", "format": "int32" }, "EventNumber": { "type": "integer", "format": "int64" }, "EventTitle": { "type": "string", "nullable": true }, "EventSubtitle": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GroupPrintInput": { "required": [ "EventId", "Groups", "Type" ], "type": "object", "properties": { "Type": { "$ref": "#/components/schemas/PrintType" }, "Groups": { "type": "array", "items": { "type": "string" } }, "EventId": { "minLength": 1, "type": "string" }, "Format": { "$ref": "#/components/schemas/PrintFormat" }, "ImageDpi": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GroupSingleOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "GroupNumber": { "type": "integer", "format": "int64" }, "EventNumber": { "type": "integer", "format": "int64" }, "EventId": { "type": "string", "format": "uuid" }, "Name": { "type": "string", "nullable": true }, "Email": { "type": "string", "nullable": true }, "AttendeeTypeId": { "type": "string", "format": "uuid" }, "JoinCode": { "type": "string", "nullable": true }, "TypeName": { "type": "string", "nullable": true }, "AttendeeCount": { "type": "integer", "format": "int32" }, "CommunityId": { "type": "string", "format": "uuid", "nullable": true }, "CommunityPartition": { "type": "string", "nullable": true }, "CommunityName": { "type": "string", "nullable": true }, "Fields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldOutput" }, "nullable": true }, "Attendees": { "type": "array", "items": { "$ref": "#/components/schemas/GroupAttendeeSummaryOutput" }, "nullable": true }, "QRCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GroupSummaryOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "GroupNumber": { "type": "integer", "format": "int64" }, "Name": { "type": "string", "nullable": true }, "Email": { "type": "string", "nullable": true }, "AttendeeTypeId": { "type": "string", "format": "uuid" }, "TypeName": { "type": "string", "nullable": true }, "AttendeeCount": { "type": "integer", "format": "int32" }, "JoinPasscode": { "type": "string", "nullable": true }, "CommunityId": { "type": "string", "format": "uuid", "nullable": true }, "CommunityPartition": { "type": "string", "nullable": true }, "CommunityName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GroupUpdateInput": { "required": [ "Email", "GroupId", "JoinCode", "Name" ], "type": "object", "properties": { "GroupId": { "type": "string", "format": "uuid" }, "AttendeeTypeId": { "type": "string", "format": "uuid", "nullable": true }, "Name": { "maxLength": 50, "minLength": 5, "type": "string" }, "Email": { "minLength": 1, "pattern": "^([0-9A-Za-z\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff']+[-._+&])*[0-9A-Za-z\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff_']+@([-0-9A-Za-z\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff]+[.])+[a-zA-Z]{2,63}$", "type": "string" }, "JoinCode": { "maxLength": 20, "minLength": 4, "type": "string" }, "AccessKey": { "type": "string", "nullable": true }, "CommunityId": { "type": "string", "format": "uuid", "nullable": true }, "FieldValues": { "type": "array", "items": { "$ref": "#/components/schemas/FieldInput" }, "nullable": true }, "UpdateNewOnly": { "type": "boolean" }, "OverrideCapacity": { "type": "boolean" }, "DontFollowRules": { "type": "boolean" } }, "additionalProperties": false }, "HookSubscribeInput": { "required": [ "Type", "Url" ], "type": "object", "properties": { "Url": { "minLength": 1, "pattern": "^(?!.*(localhost|127\\.0\\.0\\.1|\\.local\\b)).*$", "type": "string" }, "Type": { "$ref": "#/components/schemas/WebhookType" }, "Objects": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "This can be Event Numbers, Account Numbers, Client Numbers, etc.", "nullable": true } }, "additionalProperties": false }, "HookSubscribeOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Url": { "type": "string", "nullable": true }, "Type": { "$ref": "#/components/schemas/WebhookType" }, "Objects": { "type": "array", "items": { "type": "integer", "format": "int64" }, "nullable": true } }, "additionalProperties": false }, "HookUnsubscribeInput": { "required": [ "Url" ], "type": "object", "properties": { "Url": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "HookUpdateInput": { "required": [ "Url" ], "type": "object", "properties": { "Url": { "minLength": 1, "type": "string" }, "Objects": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "This can be Event Numbers, Account Numbers, Client Numbers, etc.", "nullable": true } }, "additionalProperties": false }, "InfoGrouping": { "enum": [ "None", "CheckPO", "ECheck", "Card", "AppSideload", "Reference", "EventCredit", "MassCancel" ], "type": "string" }, "InvoiceRelativeDays": { "enum": [ "UponReceipt", "SevenDaysAfterOrder", "FourteenDaysAfterOrder", "ThirtyDaysAfterOrder", "ThirtyDaysBeforeEvent", "FourteenDaysBeforeEvent", "SevenDaysBeforeEvent", "DueByEvent" ], "type": "string" }, "LocationSingleOutput": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "Address": { "type": "string", "nullable": true, "readOnly": true }, "IsSelected": { "type": "boolean" }, "IsActive": { "type": "boolean" } }, "additionalProperties": false }, "LookupAttendeeResultOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "AttendeeNumber": { "type": "integer", "format": "int64" }, "Status": { "type": "string", "nullable": true }, "IsCompleted": { "type": "boolean" }, "IsGift": { "type": "boolean" }, "IsPreRegistered": { "type": "boolean" }, "ShareEmail": { "type": "string", "nullable": true }, "GiftingEnabled": { "type": "boolean" }, "GiftLastSentAt": { "type": "string", "format": "date-time", "nullable": true }, "GiftLastSentAtLocal": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "TimeZoneId": { "type": "string", "nullable": true }, "FirstName": { "type": "string", "nullable": true }, "LastName": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true, "readOnly": true }, "AttendeeTypeId": { "type": "string", "format": "uuid" }, "TypeName": { "type": "string", "nullable": true }, "TypeAmount": { "type": "number", "format": "double" }, "TypeDisplayAmount": { "type": "number", "format": "double" }, "SectionName": { "type": "string", "nullable": true }, "RowName": { "type": "string", "nullable": true }, "SeatLabel": { "type": "string", "nullable": true }, "Amount": { "type": "number", "format": "double" }, "Addons": { "type": "number", "format": "double" }, "Discounts": { "type": "number", "format": "double" }, "SeatInfo": { "type": "string", "nullable": true }, "Culture": { "type": "string", "nullable": true }, "GroupId": { "type": "string", "format": "uuid", "nullable": true }, "GroupName": { "type": "string", "nullable": true }, "GroupEmail": { "type": "string", "nullable": true }, "AttendeeDisplay": { "$ref": "#/components/schemas/AttendeeDisplayOutput" }, "AttendeeDisplayLines": { "$ref": "#/components/schemas/AttendeeDisplayOutput" }, "DisplayPrice": { "type": "number", "format": "double", "readOnly": true }, "DisplayTotal": { "type": "number", "format": "double", "readOnly": true }, "PriceDescription": { "type": "string", "nullable": true }, "HasPaymentsToMake": { "type": "boolean" }, "DonatingBackEnabled": { "type": "boolean" }, "ChangesAreBlocked": { "type": "boolean" }, "ChangesAreBlockedAfter": { "type": "string", "format": "date-time", "nullable": true }, "HasPendingSignatures": { "type": "boolean" }, "AllSignaturesComplete": { "type": "boolean" }, "ShareEnabled": { "type": "boolean" }, "TicketInfo": { "$ref": "#/components/schemas/TicketInfoOutput" } }, "additionalProperties": false }, "LookupCreateInput": { "required": [ "Email" ], "type": "object", "properties": { "Email": { "minLength": 1, "pattern": "^([0-9A-Za-z\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff']+[-._+&])*[0-9A-Za-z\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff_']+@([-0-9A-Za-z\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff]+[.])+[a-zA-Z]{2,63}$", "type": "string" }, "EventNumber": { "type": "integer", "format": "int64", "nullable": true }, "VerrisSubdomain": { "type": "string", "nullable": true }, "VerrisCode": { "type": "string", "nullable": true }, "VerrisUid": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LookupEventResultOutput": { "type": "object", "properties": { "Event": { "$ref": "#/components/schemas/EventListOutput" }, "HasGroup": { "type": "boolean" }, "HasOrders": { "type": "boolean" }, "ShowAttendees": { "type": "boolean" } }, "additionalProperties": false }, "LookupGroupResultOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "GroupNumber": { "type": "integer", "format": "int64" }, "Name": { "type": "string", "nullable": true }, "AttendeeCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "LookupOrderResultOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "OrderKey": { "type": "string", "nullable": true }, "OrderedAt": { "type": "string", "format": "date-time" }, "OrderedAtLocal": { "type": "string", "format": "date-time" }, "TimeZoneId": { "type": "string", "nullable": true }, "BillingName": { "type": "string", "nullable": true }, "Amount": { "type": "number", "format": "double" }, "IsAdjustment": { "type": "boolean" }, "Culture": { "type": "string", "nullable": true }, "AttendeeCount": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "LookupResultOutput": { "type": "object", "properties": { "Upcoming": { "type": "array", "items": { "$ref": "#/components/schemas/LookupEventResultOutput" }, "nullable": true }, "Past": { "type": "array", "items": { "$ref": "#/components/schemas/LookupEventResultOutput" }, "nullable": true }, "Email": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrderAttendeeSummaryOutput": { "type": "object", "properties": { "AttendeeId": { "type": "string", "format": "uuid" }, "AttendeeNumber": { "type": "integer", "format": "int64" }, "AttendeeCode": { "type": "string", "nullable": true }, "AcctCode": { "type": "string", "nullable": true }, "HasName": { "type": "boolean" }, "FirstName": { "type": "string", "nullable": true }, "LastName": { "type": "string", "nullable": true }, "SectionName": { "type": "string", "nullable": true }, "RowName": { "type": "string", "nullable": true }, "SeatLabel": { "type": "string", "nullable": true }, "CreatedAt": { "type": "string", "format": "date-time" }, "TypeId": { "type": "string", "format": "uuid" }, "TypeName": { "type": "string", "nullable": true }, "GroupId": { "type": "string", "format": "uuid", "nullable": true }, "GroupName": { "type": "string", "nullable": true }, "OrderQuantity": { "type": "integer", "format": "int32" }, "Status": { "type": "string", "nullable": true }, "IsCompleted": { "type": "boolean" }, "IsPreRegistered": { "type": "boolean" }, "IsGift": { "type": "boolean" }, "ShareEmail": { "type": "string", "nullable": true }, "GiftingEnabled": { "type": "boolean" }, "GiftLastSentAt": { "type": "string", "format": "date-time", "nullable": true }, "UnitPrice": { "type": "number", "format": "double" }, "UnitDiscount": { "type": "number", "format": "double" }, "UnitAddons": { "type": "number", "format": "double" }, "UnitFee": { "type": "number", "format": "double" }, "UnitTax": { "type": "number", "format": "double" }, "UnitDelivery": { "type": "number", "description": "Deprecated. Delivery has been folded into API.Models.OrderAttendeeSummaryOutput.UnitFee; this property is kept for backwards compatibility but should be ignored.", "format": "double" }, "UnitChange": { "type": "number", "format": "double" }, "UnitTotal": { "type": "number", "format": "double" }, "UnitFees": { "type": "array", "items": { "$ref": "#/components/schemas/UnitFeeLineItemOutput" }, "nullable": true }, "DisplayPrice": { "type": "number", "format": "double", "readOnly": true }, "DisplayTotal": { "type": "number", "format": "double", "readOnly": true }, "PriceDescription": { "type": "string", "nullable": true }, "IsInclusiveFees": { "type": "boolean" }, "IsInclusiveTaxes": { "type": "boolean" }, "Refundable": { "type": "boolean" }, "Promotions": { "type": "array", "items": { "$ref": "#/components/schemas/OrderPromotionOutput" }, "nullable": true }, "IsAddon": { "type": "boolean" }, "ExternalId": { "type": "string", "nullable": true }, "ExternalDescription": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrderConfirmationResendInput": { "type": "object", "properties": { "AccessKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrderCreateDirectInput": { "required": [ "EventNumber", "FirstName", "LastName", "NumberOfTickets" ], "type": "object", "properties": { "AccessKey": { "type": "string", "nullable": true }, "FirstName": { "maxLength": 50, "minLength": 0, "type": "string" }, "LastName": { "maxLength": 50, "minLength": 0, "type": "string" }, "Organization": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "Street1": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "Street2": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "City": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "Region": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "Country": { "maxLength": 2, "minLength": 2, "type": "string", "nullable": true }, "PostalCode": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "Phone": { "maxLength": 100, "minLength": 0, "pattern": "^((?:[\\.\\*\\(\\)\\-\\/\\s\\+]*\\d){10,})(.*)$", "type": "string", "nullable": true }, "Email": { "maxLength": 100, "minLength": 0, "pattern": "^([0-9A-Za-z\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff']+[-._+&])*[0-9A-Za-z\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff_']+@([-0-9A-Za-z\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff]+[.])+[a-zA-Z]{2,63}$", "type": "string", "nullable": true }, "IsPOS": { "type": "boolean" }, "EventNumber": { "type": "integer", "format": "int64" }, "NumberOfTickets": { "maximum": 200, "minimum": 1, "type": "integer", "format": "int32" }, "Notes": { "type": "string", "nullable": true }, "SendEmail": { "type": "boolean" }, "ShipMethod": { "maxLength": 100, "minLength": 0, "type": "string", "description": "Deprecated. Delivery methods are no longer supported; this field is accepted for backwards compatibility but ignored.", "nullable": true } }, "additionalProperties": false }, "OrderCreateInput": { "required": [ "BillingCity", "BillingCountry", "BillingFirstName", "BillingLastName", "BillingPostalCode", "BillingRegion", "BillingStreet1", "CartId", "ContactPhone" ], "type": "object", "properties": { "CartId": { "minLength": 1, "type": "string" }, "AccessKey": { "type": "string", "nullable": true }, "CustomerAccountNumber": { "type": "integer", "format": "int64", "nullable": true }, "BillingFirstName": { "maxLength": 50, "minLength": 0, "type": "string" }, "BillingLastName": { "maxLength": 50, "minLength": 0, "type": "string" }, "BillingStreet1": { "maxLength": 100, "minLength": 0, "type": "string" }, "BillingStreet2": { "maxLength": 100, "minLength": 0, "type": "string", "nullable": true }, "BillingCity": { "maxLength": 100, "minLength": 0, "type": "string" }, "BillingRegion": { "maxLength": 100, "minLength": 0, "type": "string" }, "BillingCountry": { "maxLength": 2, "minLength": 2, "type": "string" }, "BillingPostalCode": { "maxLength": 20, "minLength": 0, "type": "string" }, "ContactEmail": { "maxLength": 100, "minLength": 0, "pattern": "^([0-9A-Za-z\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff']+[-._+&])*[0-9A-Za-z\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff_']+@([-0-9A-Za-z\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff]+[.])+[a-zA-Z]{2,63}$", "type": "string", "nullable": true }, "ContactPhone": { "maxLength": 50, "minLength": 0, "pattern": "^((?:[\\.\\*\\(\\)\\-\\/\\s\\+]*\\d){10,})(.*)$", "type": "string" }, "PaymentMethodId": { "type": "string", "format": "uuid", "nullable": true }, "TransactionId": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "TokenInfo": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "CardName": { "type": "string", "nullable": true }, "CardNumber": { "pattern": "^(\\d{4})(?:[- ]?)(\\d{4}|\\d{6})(?:[- ]?)((\\d{4})(?:[- ]?)(\\d{4})|(\\d{5}))$", "type": "string", "nullable": true }, "CardCsc": { "pattern": "^\\d{3,4}$", "type": "string", "nullable": true }, "CardMonth": { "type": "integer", "format": "int32", "nullable": true }, "CardYear": { "type": "integer", "format": "int32", "nullable": true }, "RoutingNumber": { "pattern": "^\\d{9}$", "type": "string", "nullable": true }, "AccountNumber": { "type": "string", "nullable": true }, "CheckPONumber": { "type": "string", "nullable": true }, "PaidInFull": { "type": "boolean", "nullable": true }, "CreditCode": { "pattern": "^\\d{4}-\\d{4}-\\d{4}$", "type": "string", "description": "The event credit code to apply to the order.", "nullable": true, "example": "1234-5678-9012" }, "PaymentNumberForStorage": { "type": "string", "nullable": true, "readOnly": true }, "Notes": { "type": "string", "nullable": true }, "IsKiosk": { "type": "boolean" }, "SendEmail": { "type": "boolean" }, "Via": { "type": "string", "nullable": true }, "IsInvoice": { "type": "boolean" }, "InvoiceDue": { "$ref": "#/components/schemas/InvoiceRelativeDays" }, "ExchangeId": { "type": "string", "format": "uuid", "nullable": true }, "OriginalOrderId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "OrderCreateOutput": { "type": "object", "properties": { "RequiresAction": { "type": "boolean" }, "ActionInfo": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "Results": { "type": "array", "items": { "$ref": "#/components/schemas/OrderResultOutput" }, "nullable": true } }, "additionalProperties": false }, "OrderCreatePOSInput": { "required": [ "BillingFirstName", "BillingLastName", "CartId" ], "type": "object", "properties": { "CartId": { "minLength": 1, "type": "string" }, "AccessKey": { "type": "string", "nullable": true }, "BillingFirstName": { "maxLength": 50, "minLength": 0, "type": "string" }, "BillingLastName": { "maxLength": 50, "minLength": 0, "type": "string" }, "BillingPostalCode": { "maxLength": 20, "minLength": 0, "type": "string", "nullable": true }, "ContactEmail": { "maxLength": 100, "minLength": 0, "pattern": "^([0-9A-Za-z\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff']+[-._+&])*[0-9A-Za-z\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff_']+@([-0-9A-Za-z\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff]+[.])+[a-zA-Z]{2,63}$", "type": "string", "nullable": true }, "ContactPhone": { "maxLength": 50, "minLength": 0, "pattern": "^((?:[\\.\\*\\(\\)\\-\\/\\s\\+]*\\d){10,})(.*)$", "type": "string", "nullable": true }, "PaymentMethodId": { "type": "string", "format": "uuid", "nullable": true }, "TransactionId": { "maxLength": 255, "minLength": 0, "type": "string", "nullable": true }, "TokenInfo": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "CardName": { "type": "string", "nullable": true }, "CardNumber": { "pattern": "^(\\d{4})(?:[- ]?)(\\d{4}|\\d{6})(?:[- ]?)((\\d{4})(?:[- ]?)(\\d{4})|(\\d{5}))$", "type": "string", "nullable": true }, "CardCsc": { "pattern": "^\\d{3,4}$", "type": "string", "nullable": true }, "CardMonth": { "type": "integer", "format": "int32", "nullable": true }, "CardYear": { "type": "integer", "format": "int32", "nullable": true }, "RoutingNumber": { "pattern": "^\\d{9}$", "type": "string", "nullable": true }, "AccountNumber": { "type": "string", "nullable": true }, "CheckPONumber": { "type": "string", "nullable": true }, "PaidInFull": { "type": "boolean", "nullable": true }, "CreditCode": { "pattern": "^\\d{4}-\\d{4}-\\d{4}$", "type": "string", "description": "The event credit code to apply to the order.", "nullable": true, "example": "1234-5678-9012" }, "PaymentNumberForStorage": { "type": "string", "nullable": true, "readOnly": true }, "Notes": { "type": "string", "nullable": true }, "IsKiosk": { "type": "boolean" }, "SendEmail": { "type": "boolean" }, "Via": { "type": "string", "nullable": true }, "IsInvoice": { "type": "boolean" }, "InvoiceDue": { "$ref": "#/components/schemas/InvoiceRelativeDays" }, "ExchangeId": { "type": "string", "format": "uuid", "nullable": true }, "OriginalOrderId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "OrderHelpdeskOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "OrderKey": { "type": "string", "nullable": true }, "ObjectNumber": { "type": "integer", "format": "int64" }, "ObjectTitle": { "type": "string", "nullable": true }, "ObjectSubtitle": { "type": "string", "nullable": true }, "OrderedAt": { "type": "string", "format": "date-time" }, "OrderedAtLocal": { "type": "string", "format": "date-time" }, "FirstName": { "type": "string", "nullable": true }, "LastName": { "type": "string", "nullable": true }, "Amount": { "type": "number", "format": "double" }, "IsAdjustment": { "type": "boolean" }, "Culture": { "type": "string", "nullable": true }, "FlagState": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrderListOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "OrderKey": { "type": "string", "nullable": true }, "OrderedAt": { "type": "string", "format": "date-time" }, "OrderedAtLocal": { "type": "string", "format": "date-time" }, "IsPOS": { "type": "boolean" }, "IsKiosk": { "type": "boolean" }, "IsApp": { "type": "boolean" }, "AcctCode": { "type": "string", "nullable": true }, "ObjectNumber": { "type": "integer", "format": "int64" }, "IsAdjustment": { "type": "boolean" }, "BillingFirstName": { "type": "string", "nullable": true }, "BillingLastName": { "type": "string", "nullable": true }, "HostAddress": { "type": "string", "nullable": true }, "ThirdPartyCustomerId": { "type": "string", "nullable": true }, "SubTotal": { "type": "number", "format": "double" }, "UndistributedFees": { "type": "number", "format": "double" }, "OrderTotal": { "type": "number", "format": "double" }, "AttendeeTotal": { "type": "number", "format": "double" }, "DiscountTotal": { "type": "number", "format": "double" }, "FeeTotal": { "type": "number", "format": "double" }, "TaxTotal": { "type": "number", "format": "double" }, "DeliveryTotal": { "type": "number", "description": "Deprecated. Delivery has been folded into API.Models.OrderListOutput.FeeTotal; this property is kept for backwards compatibility but should be ignored.", "format": "double" }, "FeesTotal": { "type": "number", "format": "double" }, "Payments": { "type": "array", "items": { "$ref": "#/components/schemas/OrderListPaymentOutput" }, "nullable": true }, "TransactionTotal": { "type": "number", "format": "double", "readOnly": true }, "PaymentMethodId": { "type": "string", "format": "uuid", "readOnly": true }, "PaymentMethod": { "type": "string", "nullable": true, "readOnly": true }, "PaymentNumber": { "type": "string", "nullable": true, "readOnly": true }, "TransactionId": { "type": "string", "nullable": true, "readOnly": true }, "ExternalInvoiceId": { "type": "string", "nullable": true, "readOnly": true }, "Summary": { "type": "string", "nullable": true }, "ContactEmail": { "type": "string", "nullable": true }, "ContactPhone": { "type": "string", "nullable": true }, "OrderFee": { "type": "number", "description": "Deprecated. Order fees have been folded into API.Models.OrderListOutput.FeeTotal; this property is kept for backwards compatibility but should be ignored.", "format": "double" }, "AttendeeCount": { "type": "integer", "format": "int32" }, "PlacedThrough": { "type": "string", "nullable": true }, "CustomerAccountNumber": { "type": "integer", "format": "int64", "nullable": true }, "Notes": { "type": "string", "nullable": true }, "ExternalId": { "type": "string", "nullable": true }, "PaidInFull": { "type": "boolean" }, "ExternalCustomerId": { "type": "string", "nullable": true }, "FlagState": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrderListPaymentOutput": { "type": "object", "properties": { "PaymentMethodId": { "type": "string", "format": "uuid" }, "PaymentMethod": { "type": "string", "nullable": true }, "PaymentNumber": { "type": "string", "nullable": true }, "TransactionId": { "type": "string", "nullable": true }, "TransactionTotal": { "type": "number", "format": "double" }, "ExternalInvoiceId": { "type": "string", "nullable": true }, "CreditNumber": { "type": "integer", "format": "int64", "nullable": true }, "PaidInFull": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "OrderPrintInput": { "required": [ "Orders", "Type" ], "type": "object", "properties": { "Type": { "$ref": "#/components/schemas/PrintType" }, "Orders": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "Format": { "$ref": "#/components/schemas/PrintFormat" }, "ImageDpi": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "OrderPromotionOutput": { "type": "object", "properties": { "PromotionId": { "type": "string", "format": "uuid" }, "DiscountAmount": { "type": "number", "format": "double" } }, "additionalProperties": false }, "OrderReaderStartInput": { "required": [ "BillingFirstName", "BillingLastName", "CartId" ], "type": "object", "properties": { "CartId": { "minLength": 1, "type": "string" }, "AccessKey": { "type": "string", "nullable": true }, "BillingFirstName": { "maxLength": 50, "minLength": 0, "type": "string" }, "BillingLastName": { "maxLength": 50, "minLength": 0, "type": "string" }, "ContactEmail": { "maxLength": 100, "minLength": 0, "pattern": "^([0-9A-Za-z\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff']+[-._+&])*[0-9A-Za-z\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff_']+@([-0-9A-Za-z\u00c0-\u00d6\u00d8-\u00f6\u00f8-\u00ff]+[.])+[a-zA-Z]{2,63}$", "type": "string", "nullable": true }, "ContactPhone": { "maxLength": 50, "minLength": 0, "pattern": "^((?:[\\.\\*\\(\\)\\-\\/\\s\\+]*\\d){10,})(.*)$", "type": "string", "nullable": true }, "Notes": { "type": "string", "nullable": true }, "IsKiosk": { "type": "boolean" }, "SendEmail": { "type": "boolean" }, "Via": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrderReaderStartOutput": { "type": "object", "properties": { "ReferenceId": { "type": "string", "format": "uuid" }, "CartId": { "type": "string", "nullable": true }, "ExternalId": { "type": "string", "nullable": true }, "AppFee": { "type": "number", "format": "double" }, "Description": { "type": "string", "nullable": true }, "Metadata": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true } }, "additionalProperties": false }, "OrderRelationshipOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "OrderKey": { "type": "string", "nullable": true }, "OrderedAt": { "type": "string", "format": "date-time" }, "IsAdjustment": { "type": "boolean" }, "Payments": { "type": "array", "items": { "$ref": "#/components/schemas/OrderRelationshipPaymentOutput" }, "nullable": true }, "TransactionId": { "type": "string", "nullable": true, "readOnly": true }, "TransactionTotal": { "type": "number", "format": "double", "readOnly": true } }, "additionalProperties": false }, "OrderRelationshipPaymentOutput": { "type": "object", "properties": { "TransactionId": { "type": "string", "nullable": true }, "TransactionTotal": { "type": "number", "format": "double" }, "ExternalInvoiceId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrderResultOutput": { "type": "object", "properties": { "OrderKey": { "type": "string", "nullable": true }, "OrderId": { "type": "string", "format": "uuid" }, "ObjectNumber": { "type": "integer", "format": "int64" }, "OrderTotal": { "type": "number", "format": "double" }, "Quantity": { "type": "integer", "format": "int32" }, "AttendeeCount": { "type": "integer", "format": "int32" }, "AddonCount": { "type": "integer", "format": "int32" }, "Summary": { "type": "string", "nullable": true }, "Type": { "type": "string", "nullable": true }, "ContactEmail": { "type": "string", "nullable": true }, "AnyGeneratesTicket": { "type": "boolean" } }, "additionalProperties": false }, "OrderSingleOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "OrderKey": { "type": "string", "nullable": true }, "ObjectNumber": { "type": "integer", "format": "int64" }, "AttendeeCount": { "type": "integer", "format": "int32" }, "OrderedAt": { "type": "string", "format": "date-time" }, "OrderedAtLocal": { "type": "string", "format": "date-time" }, "IsAdjustment": { "type": "boolean" }, "IsPOS": { "type": "boolean" }, "IsKiosk": { "type": "boolean" }, "IsApp": { "type": "boolean" }, "AcctCode": { "type": "string", "nullable": true }, "BillingName": { "type": "string", "nullable": true }, "BillingAddress": { "type": "string", "nullable": true }, "BillingFirstName": { "type": "string", "nullable": true }, "BillingLastName": { "type": "string", "nullable": true }, "BillingOrganization": { "type": "string", "nullable": true }, "BillingStreet1": { "type": "string", "nullable": true }, "BillingStreet2": { "type": "string", "nullable": true }, "BillingCity": { "type": "string", "nullable": true }, "BillingRegion": { "type": "string", "nullable": true }, "BillingPostal": { "type": "string", "nullable": true }, "BillingCountry": { "type": "string", "nullable": true }, "ContactPhone": { "type": "string", "nullable": true }, "ContactEmail": { "type": "string", "nullable": true }, "DeliveryMethod": { "type": "string", "nullable": true }, "HostAddress": { "type": "string", "nullable": true }, "ThirdPartyCustomerId": { "type": "string", "nullable": true }, "SubTotal": { "type": "number", "format": "double" }, "Total": { "type": "number", "format": "double" }, "Summary": { "type": "string", "nullable": true }, "IsAttendeeTypeAdjustment": { "type": "boolean" }, "AttendeeTotal": { "type": "number", "format": "double" }, "DiscountTotal": { "type": "number", "format": "double" }, "OrderFee": { "type": "number", "description": "Deprecated. Order fees have been folded into API.Models.OrderSingleOutput.FeeTotal; this property is kept for backwards compatibility but should be ignored.", "format": "double" }, "FeeTotal": { "type": "number", "format": "double" }, "TaxTotal": { "type": "number", "format": "double" }, "DeliveryTotal": { "type": "number", "description": "Deprecated. Delivery has been folded into API.Models.OrderSingleOutput.FeeTotal; this property is kept for backwards compatibility but should be ignored.", "format": "double" }, "TaxLabel": { "type": "string", "nullable": true }, "UndistributedFees": { "type": "number", "format": "double" }, "FeesTotal": { "type": "number", "format": "double" }, "Fields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldOutput" }, "nullable": true }, "Attendees": { "type": "array", "items": { "$ref": "#/components/schemas/OrderAttendeeSummaryOutput" }, "nullable": true }, "RelatedOrders": { "type": "array", "items": { "$ref": "#/components/schemas/OrderRelationshipOutput" }, "nullable": true }, "Payments": { "type": "array", "items": { "$ref": "#/components/schemas/OrderListPaymentOutput" }, "nullable": true }, "PaymentMethod": { "type": "string", "nullable": true, "readOnly": true }, "TransactionId": { "type": "string", "nullable": true, "readOnly": true }, "TransactionTotal": { "type": "number", "format": "double", "readOnly": true }, "ExternalInvoiceId": { "type": "string", "nullable": true, "readOnly": true }, "QRCode": { "type": "string", "nullable": true }, "Notes": { "type": "string", "nullable": true }, "ExternalId": { "type": "string", "nullable": true }, "PaidInFull": { "type": "boolean" }, "ExternalCustomerId": { "type": "string", "nullable": true }, "FlagState": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OrderSmsInput": { "type": "object", "properties": { "OrderId": { "type": "string", "format": "uuid" }, "PhoneNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentMethodListOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Name": { "type": "string", "nullable": true }, "IsEnabled": { "type": "boolean" } }, "additionalProperties": false }, "PaymentMethodOutput": { "type": "object", "properties": { "PaymentMethodId": { "type": "string", "format": "uuid" }, "Name": { "type": "string", "nullable": true }, "IsElectronic": { "type": "boolean" }, "InfoGrouping": { "type": "string", "nullable": true }, "Grouping": { "$ref": "#/components/schemas/InfoGrouping" } }, "additionalProperties": false }, "PaymentProfileConfigInvoiceItem": { "type": "object", "properties": { "AllowAdmin": { "type": "boolean" }, "AllowInternet": { "type": "boolean" }, "RelativeDays": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PaymentProfileConfigOutput": { "type": "object", "properties": { "LocationId": { "type": "string", "nullable": true }, "LocationName": { "type": "string", "nullable": true }, "MerchantId": { "type": "string", "nullable": true }, "MerchantName": { "type": "string", "nullable": true }, "AccessToken": { "type": "string", "nullable": true }, "Currency": { "type": "string", "nullable": true }, "InternalDescription": { "type": "string", "nullable": true }, "Invoice": { "$ref": "#/components/schemas/PaymentProfileConfigInvoiceItem" }, "Scopes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "Status": { "type": "string", "nullable": true }, "AllowCards": { "type": "boolean" }, "AllowWallets": { "type": "boolean" }, "AllowAch": { "type": "boolean" }, "AllowAfterpay": { "type": "boolean" }, "AllowCashApp": { "type": "boolean" }, "AllowGiftCards": { "type": "boolean" } }, "additionalProperties": false }, "PaymentProfileListOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Name": { "type": "string", "nullable": true }, "AccountName": { "type": "string", "nullable": true }, "GatewayId": { "type": "string", "format": "uuid" }, "GatewayName": { "type": "string", "nullable": true }, "SupportsAutoFees": { "type": "boolean" }, "SupportsSideloading": { "type": "boolean" }, "AllowsReferenceSales": { "type": "boolean" }, "AllowsStandaloneCredits": { "type": "boolean" }, "ReferenceDayLimit": { "type": "integer", "format": "int32" }, "Options": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "ElectronicPaymentMethods": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethodListOutput" }, "nullable": true }, "Config": { "$ref": "#/components/schemas/PaymentProfileConfigOutput" } }, "additionalProperties": false }, "PaymentProfileSingleOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Name": { "type": "string", "nullable": true }, "AccountName": { "type": "string", "nullable": true }, "GatewayId": { "type": "string", "format": "uuid" }, "GatewayName": { "type": "string", "nullable": true }, "SupportsAutoFees": { "type": "boolean" }, "SupportsSideloading": { "type": "boolean" }, "AllowsReferenceSales": { "type": "boolean" }, "AllowsStandaloneCredits": { "type": "boolean" }, "ReferenceDayLimit": { "type": "integer", "format": "int32" }, "Options": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "ElectronicPaymentMethods": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethodListOutput" }, "nullable": true }, "Config": { "$ref": "#/components/schemas/PaymentProfileConfigOutput" } }, "additionalProperties": false }, "PriceMethod": { "enum": [ "Set", "Custom", "Payments" ], "type": "string" }, "PrintFormat": { "enum": [ "PDF", "PNG", "JPG", "GIF", "BMP", "TIFF", "ZPL" ], "type": "string" }, "PrintType": { "enum": [ "Ticket", "ETicket", "Receipt", "MailingLabel", "WillCall", "NameBadge", "Season" ], "type": "string" }, "PromotionCreateImportInput": { "required": [ "Names", "TemplateId" ], "type": "object", "properties": { "TemplateId": { "type": "string", "format": "uuid" }, "Names": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "PromotionCreateInput": { "required": [ "Prefix", "Quantity", "TemplateId" ], "type": "object", "properties": { "TemplateId": { "type": "string", "format": "uuid" }, "Quantity": { "maximum": 250, "minimum": 1, "type": "integer", "format": "int32" }, "Prefix": { "maxLength": 13, "minLength": 0, "type": "string" } }, "additionalProperties": false }, "PromotionCreateOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Description": { "type": "string", "nullable": true }, "StartsAt": { "type": "string", "format": "date-time", "nullable": true }, "EndsAt": { "type": "string", "format": "date-time", "nullable": true }, "Group": { "type": "string", "nullable": true }, "Kind": { "type": "string", "nullable": true }, "IsSingleUse": { "type": "boolean" }, "IsRedeemed": { "type": "boolean" }, "AdminVisible": { "type": "boolean" }, "InternetVisible": { "type": "boolean" }, "Amount": { "type": "number", "format": "double" }, "IsPercentage": { "type": "boolean" }, "AutoCalculate": { "type": "boolean" }, "Names": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "PromotionEventOutput": { "type": "object", "properties": { "EventId": { "type": "string", "format": "uuid" }, "AttendeeTypes": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "PromotionKind": { "enum": [ "Standard", "Template", "Dynamic" ], "type": "string" }, "PromotionListOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Description": { "type": "string", "nullable": true }, "StartsAt": { "type": "string", "format": "date-time", "nullable": true }, "EndsAt": { "type": "string", "format": "date-time", "nullable": true }, "Group": { "type": "string", "nullable": true }, "Kind": { "type": "string", "nullable": true }, "IsSingleUse": { "type": "boolean" }, "IsRedeemed": { "type": "boolean" }, "AdminVisible": { "type": "boolean" }, "InternetVisible": { "type": "boolean" }, "Amount": { "type": "number", "format": "double" }, "IsPercentage": { "type": "boolean" }, "AutoCalculate": { "type": "boolean" }, "Names": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "PromotionSingleOutput": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Description": { "type": "string", "nullable": true }, "StartsAt": { "type": "string", "format": "date-time", "nullable": true }, "EndsAt": { "type": "string", "format": "date-time", "nullable": true }, "Group": { "type": "string", "nullable": true }, "Kind": { "type": "string", "nullable": true }, "IsSingleUse": { "type": "boolean" }, "IsRedeemed": { "type": "boolean" }, "AdminVisible": { "type": "boolean" }, "InternetVisible": { "type": "boolean" }, "Amount": { "type": "number", "format": "double" }, "IsPercentage": { "type": "boolean" }, "AutoCalculate": { "type": "boolean" }, "Quantity": { "type": "integer", "format": "int32" }, "Limit": { "type": "integer", "format": "int32" }, "Exclude": { "type": "integer", "format": "int32" }, "IsMultiple": { "type": "boolean" }, "SpanChildren": { "type": "boolean" }, "InEachChild": { "type": "boolean" }, "IncludeAddons": { "type": "boolean" }, "AllInGroup": { "type": "boolean" }, "Names": { "type": "array", "items": { "type": "string" }, "nullable": true }, "RelatedPromotions": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "Events": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionEventOutput" }, "nullable": true } }, "additionalProperties": false }, "RegionDetailOutput": { "type": "object", "properties": { "Code": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "ISO": { "type": "integer", "format": "int32", "nullable": true }, "Regions": { "type": "array", "items": { "$ref": "#/components/schemas/RegionDetailOutput" }, "nullable": true } }, "additionalProperties": false }, "RelatedEventOutput": { "type": "object", "properties": { "ClientKey": { "type": "string", "nullable": true }, "UrlKey": { "type": "string", "nullable": true }, "EventNumber": { "type": "integer", "format": "int64" }, "EventTitle": { "type": "string", "nullable": true }, "Subtitle": { "type": "string", "nullable": true }, "ImageUrl": { "type": "string", "nullable": true }, "DateInfo": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RemoteFetchResult": { "type": "object", "properties": { "Label": { "type": "string", "nullable": true }, "Value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SeatReservedStateOutput": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int32" }, "Name": { "type": "string", "nullable": true }, "BackColor": { "$ref": "#/components/schemas/ColorOutput" }, "ForeColor": { "$ref": "#/components/schemas/ColorOutput" } }, "additionalProperties": false }, "SessionAttendeeListOutput": { "type": "object", "properties": { "SessionAttendees": { "type": "array", "items": { "$ref": "#/components/schemas/SessionAttendeeOutput" }, "nullable": true }, "FlexAttendees": { "type": "array", "items": { "$ref": "#/components/schemas/SessionFlexPassAttendeeOutput" }, "nullable": true } }, "additionalProperties": false }, "SessionAttendeeOutput": { "type": "object", "properties": { "AttendeeNumber": { "type": "integer", "format": "int64" }, "FirstName": { "type": "string", "nullable": true }, "LastName": { "type": "string", "nullable": true }, "SectionName": { "type": "string", "nullable": true }, "RowName": { "type": "string", "nullable": true }, "SeatLabel": { "type": "string", "nullable": true }, "TypeName": { "type": "string", "nullable": true }, "CheckedIn": { "type": "boolean" }, "CheckedInAt": { "type": "string", "format": "date-time", "nullable": true }, "SeatInfo": { "type": "string", "nullable": true, "readOnly": true }, "IsAddon": { "type": "boolean" } }, "additionalProperties": false }, "SessionCheckinEntryItem": { "required": [ "CheckedInAt", "Code" ], "type": "object", "properties": { "Code": { "minLength": 1, "type": "string" }, "CheckedInAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "SessionCheckinMultipleInput": { "type": "object", "properties": { "Codes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "Entries": { "type": "array", "items": { "$ref": "#/components/schemas/SessionCheckinEntryItem" }, "nullable": true }, "IsVerified": { "type": "boolean" } }, "additionalProperties": false }, "SessionCheckinMultipleOutput": { "type": "object", "properties": { "Success": { "type": "boolean" }, "CheckedInAt": { "type": "string", "format": "date-time", "nullable": true }, "Message": { "type": "string", "nullable": true }, "Code": { "type": "string", "nullable": true }, "RequiresVerification": { "type": "boolean" } }, "additionalProperties": false }, "SessionCheckoutMultipleInput": { "type": "object", "properties": { "Codes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "SessionCheckoutMultipleOutput": { "type": "object", "properties": { "Success": { "type": "boolean" }, "CheckedInAt": { "type": "string", "format": "date-time", "nullable": true }, "Message": { "type": "string", "nullable": true }, "Code": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SessionFlexPassAttendeeOutput": { "type": "object", "properties": { "AttendeeNumber": { "type": "integer", "format": "int64" }, "FirstName": { "type": "string", "nullable": true }, "LastName": { "type": "string", "nullable": true }, "TypeName": { "type": "string", "nullable": true }, "CheckedIn": { "type": "boolean" }, "FlexPass": { "$ref": "#/components/schemas/AttendeeFlexPassOutput" }, "IsAddon": { "type": "boolean" } }, "additionalProperties": false }, "SessionFlexPassCheckinInput": { "required": [ "AttendeeId", "Quantity" ], "type": "object", "properties": { "Quantity": { "maximum": 2147483647, "minimum": 1, "type": "integer", "format": "int32" }, "AttendeeId": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "SessionFlexPassCheckinOutput": { "type": "object", "properties": { "Success": { "type": "boolean" }, "Message": { "type": "string", "nullable": true }, "CheckedInAt": { "type": "string", "format": "date-time", "nullable": true }, "AttendeeCheckinIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "FlexRedemptions": { "type": "integer", "format": "int32", "nullable": true }, "FlexRedemptionsText": { "type": "string", "nullable": true }, "EventRedemptions": { "type": "integer", "format": "int32", "nullable": true }, "EventRedemptionsText": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SessionFlexPassCheckoutInput": { "required": [ "AttendeeCheckinId", "AttendeeId" ], "type": "object", "properties": { "AttendeeCheckinId": { "type": "string", "format": "uuid" }, "AttendeeId": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "SessionFlexPassCheckoutOutput": { "type": "object", "properties": { "Success": { "type": "boolean" }, "Message": { "type": "string", "nullable": true }, "FlexRedemptions": { "type": "integer", "format": "int32", "nullable": true }, "FlexRedemptionsText": { "type": "string", "nullable": true }, "EventRedemptions": { "type": "integer", "format": "int32", "nullable": true }, "EventRedemptionsText": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SessionGroupDetailOutput": { "type": "object", "properties": { "GroupNumber": { "type": "integer", "format": "int64" }, "EventId": { "type": "string", "format": "uuid" }, "AttendeeTypeId": { "type": "string", "format": "uuid" }, "TypeName": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "Email": { "type": "string", "nullable": true }, "AttendeeCount": { "type": "integer", "format": "int32" }, "CommunityId": { "type": "string", "format": "uuid", "nullable": true }, "CommunityPartition": { "type": "string", "nullable": true }, "CommunityName": { "type": "string", "nullable": true }, "Fields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldDisplayOutput" }, "nullable": true }, "Attendees": { "type": "array", "items": { "$ref": "#/components/schemas/SessionAttendeeOutput" }, "nullable": true } }, "additionalProperties": false }, "SessionOrderDetailOutput": { "type": "object", "properties": { "OrderKey": { "type": "string", "nullable": true }, "ObjectNumber": { "type": "integer", "format": "int64" }, "AttendeeCount": { "type": "integer", "format": "int32" }, "OrderedAt": { "type": "string", "format": "date-time" }, "BillingName": { "type": "string", "nullable": true }, "BillingAddress": { "type": "string", "nullable": true }, "BillingFirstName": { "type": "string", "nullable": true }, "BillingLastName": { "type": "string", "nullable": true }, "BillingOrganization": { "type": "string", "nullable": true }, "BillingStreet1": { "type": "string", "nullable": true }, "BillingStreet2": { "type": "string", "nullable": true }, "BillingCity": { "type": "string", "nullable": true }, "BillingRegion": { "type": "string", "nullable": true }, "BillingPostal": { "type": "string", "nullable": true }, "BillingCountry": { "type": "string", "nullable": true }, "ContactPhone": { "type": "string", "nullable": true }, "ContactEmail": { "type": "string", "nullable": true }, "PaymentMethods": { "type": "array", "items": { "type": "string" }, "nullable": true }, "PaymentMethod": { "type": "string", "nullable": true, "readOnly": true }, "DeliveryMethod": { "type": "string", "nullable": true }, "Fields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldDisplayOutput" }, "nullable": true }, "Attendees": { "type": "array", "items": { "$ref": "#/components/schemas/SessionAttendeeOutput" }, "nullable": true } }, "additionalProperties": false }, "SharedCapacityKind": { "enum": [ "Default", "Time", "Pass" ], "type": "string" }, "StringStringKeyValuePair": { "type": "object", "properties": { "Key": { "type": "string", "nullable": true }, "Value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TerminalCreateInput": { "type": "object", "properties": { "LocationId": { "type": "string", "nullable": true }, "PairingCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TerminalCreateOutput": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "SerialNumber": { "type": "string", "nullable": true }, "PairingCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TerminalOutput": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "SerialNumber": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "Display": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ThemeOutput": { "type": "object", "properties": { "LogoUrl": { "type": "string", "nullable": true }, "LogoPosition": { "type": "string", "nullable": true }, "HeaderUrlLarge": { "type": "string", "nullable": true }, "HeaderUrlMobile": { "type": "string", "nullable": true }, "BackgroundCss": { "type": "string", "nullable": true }, "TextColor": { "type": "string", "nullable": true }, "LinkColor": { "type": "string", "nullable": true }, "HomeUrl": { "type": "string", "nullable": true }, "HeaderHtml": { "type": "string", "nullable": true }, "ClientKey": { "type": "string", "nullable": true }, "ClientName": { "type": "string", "nullable": true }, "UrlKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TicketInfoOutput": { "type": "object", "properties": { "AttendeeTypeName": { "type": "string", "nullable": true }, "AttendeeName": { "type": "string", "nullable": true }, "Title": { "type": "string", "nullable": true }, "Section": { "type": "string", "nullable": true }, "RowLabel": { "type": "string", "nullable": true }, "Row": { "type": "string", "nullable": true }, "Seat": { "type": "string", "nullable": true }, "FlexSummary": { "type": "string", "nullable": true }, "Field1Label": { "type": "string", "nullable": true }, "Field1Value": { "type": "string", "nullable": true }, "Field2Label": { "type": "string", "nullable": true }, "Field2Value": { "type": "string", "nullable": true }, "Field3Label": { "type": "string", "nullable": true }, "Field3Value": { "type": "string", "nullable": true }, "ImageUrl": { "type": "string", "nullable": true }, "TicketRenderType": { "$ref": "#/components/schemas/TicketRenderType" }, "TicketNotes": { "type": "string", "nullable": true }, "TicketAd": { "type": "string", "nullable": true }, "EventDate": { "type": "string", "nullable": true }, "EventTime": { "type": "string", "nullable": true }, "EventDoorTime": { "type": "string", "nullable": true }, "EventTitle": { "type": "string", "nullable": true }, "QrImageUrl": { "type": "string", "nullable": true }, "QrText": { "type": "string", "nullable": true }, "PassUrl": { "type": "string", "nullable": true }, "WalletUrl": { "type": "string", "nullable": true }, "BundledPassUrl": { "type": "string", "nullable": true }, "BundledWalletUrl": { "type": "string", "nullable": true }, "PrintUrl": { "type": "string", "nullable": true }, "BundledPrintUrl": { "type": "string", "nullable": true }, "EditUrl": { "type": "string", "nullable": true }, "FlexPassRedemptionsUsed": { "type": "string", "nullable": true }, "FlexPassRedemptions": { "type": "array", "items": { "$ref": "#/components/schemas/FlexPassCheckinItem" }, "nullable": true }, "IsFlexOrderOrGroupTicket": { "type": "boolean" }, "TicketColor": { "type": "string", "nullable": true }, "TicketClassName": { "type": "string", "nullable": true }, "EventContactInfo": { "type": "string", "nullable": true }, "OrderInfo": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "AttendeesDescription": { "type": "string", "nullable": true }, "TimeSlotName": { "type": "string", "nullable": true }, "SharedCapacityName": { "type": "string", "nullable": true }, "LocationInfo": { "type": "string", "nullable": true }, "DateInfo": { "type": "string", "nullable": true }, "BundledTicketUrl": { "type": "string", "nullable": true }, "IsBundledTicket": { "type": "boolean" }, "StartsEndsSameDay": { "type": "boolean" }, "Coordinates": { "type": "string", "nullable": true }, "Address": { "type": "string", "nullable": true }, "MapAddress": { "type": "string", "nullable": true }, "ContactEmail": { "type": "string", "nullable": true }, "ContactPhone": { "type": "string", "nullable": true }, "IsFlexPass": { "type": "boolean" } }, "additionalProperties": false }, "TicketRenderType": { "enum": [ "Assigned", "AssignedSection", "GeneralAdmission", "FlexPass", "TimeSlot", "Groups", "Orders" ], "type": "string" }, "TypeKind": { "enum": [ "InPerson", "Donation", "Product" ], "type": "string" }, "UnitFeeLineItemInput": { "required": [ "Amount", "FeeType", "Label" ], "type": "object", "properties": { "Label": { "minLength": 1, "type": "string" }, "FeeType": { "$ref": "#/components/schemas/FeeItemType" }, "Amount": { "type": "number", "format": "double" } }, "additionalProperties": false }, "UnitFeeLineItemOutput": { "type": "object", "properties": { "Label": { "type": "string", "description": "Display label (e.g. \"Service Fee\", \"Sales Tax\").", "nullable": true }, "FeeType": { "$ref": "#/components/schemas/FeeItemType" }, "Amount": { "type": "number", "description": "The evaluated amount for this line item.", "format": "double" } }, "additionalProperties": false, "description": "A single fee or tax line item evaluated for an attendee from the attendee\r\ntype's customFees configuration. On cart outputs this is a live evaluation;\r\non order outputs it is the snapshot of what was collected at purchase time." }, "WebhookType": { "enum": [ "Attendee_Created", "Attendee_Updated", "Attendee_Cancelled", "Order_Completed", "Event_Created", "Group_Updated", "Group_Created", "Group_Deleted", "Zapier_Post", "Event_Updated", "Order_Updated", "Client_Created", "Client_Activated", "Client_Deactivated", "Email_Unsubscribe", "Email_Resubscribe" ], "type": "string" } }, "securitySchemes": { "apiKey": { "type": "apiKey", "description": "The App Key you received from https://developer.brushfire.com/key", "name": "Authorization", "in": "header" } } } }