> ## Documentation Index > Fetch the complete documentation index at: https://apidocs.sessionboard.com/llms.txt > Use this file to discover all available pages before exploring further. # Create a registration > Place an order on the integrator's behalf: one order for one or more people, each with a ticket type, through one of the event's registration forms. Use it to bring in registrations taken somewhere else, or to add comps and invoiced registrations. **This creates.** `POST /registrations` is not a search. `payment` says how the order is paid: | `payment` | Order status | Order `payment_method` | | --- | --- | --- | | `comp` | `paid`, total `0` — every line is fully discounted | `comp` | | `invoice` | `awaiting_invoice` (or `paid` when the total is `0`) | `invoice` | | `paid_externally` | `paid` — the money was taken in another system | `external` | | `cash` | `paid` | `cash` | | `check` | `paid` | `check` | The order goes through the same checks as a registration on the form: each ticket type must be sold on the form and on sale, capacity and per-order limits apply, the form's required questions must be answered, and an email can be registered for the event only once. The form's open and close dates do **not** apply, and `invoice` is accepted even if the form does not offer pay-later. Each registration is `confirmed`, or `pending_approval` when the event's approval rules hold it. **Idempotency.** Send an `idempotency_key` (a string of 1–128 characters) unique to the order in your system. Repeating a request with a key the event has already seen returns the original order and registrations with `200` instead of `201`, and creates nothing — even if the rest of the body differs. Recorded in the event's History as an API change. Requires `write:registrations`. ## OpenAPI ````yaml /api-reference/openapi.yaml post /v1/event/{eventId}/registrations openapi: 3.1.0 info: title: Sessionboard Public API version: '1.0' description: >- REST API for managing sessions, speakers, contacts, sponsors, exhibitors, and event data on the Sessionboard platform. contact: name: Sessionboard Support email: support@sessionboard.com termsOfService: https://www.sessionboard.com/legal/terms-of-service servers: - url: https://public-api.sessionboard.com description: US Region - url: https://public-api-eu.sessionboard.com description: EU Region security: - ApiKey: [] - BearerToken: [] tags: - name: Events description: Manage events on the platform. - name: Sessions description: Search and retrieve sessions within an event. - name: Session Writes description: >- Create, update, delete, and restore sessions. Requires the `write:sessions` scope. - name: Contact Writes description: >- Create, update, delete, and restore contacts. Requires the `write:contacts` scope. - name: Exhibitor Writes description: >- Create, update, delete, and restore exhibitors. Requires the `write:exhibitors` scope. - name: Sponsor Writes description: >- Create, update, delete, and restore sponsors. Requires the `write:sponsors` scope. - name: Field Writes description: >- Create, update, and delete custom fields. Requires the `write:fields` scope. - name: Speakers description: Search and retrieve speakers within an event. - name: Participants description: | Search and retrieve every contact holding a session role on an event — speakers, chairpersons, moderators and custom roles — with the roles each one holds, and list the event's participant roles. - name: Contacts description: Search and retrieve contacts at the organization or event level. - name: Sponsors description: Search and retrieve sponsors within an event. - name: Exhibitors description: Search and retrieve exhibitors within an event. - name: Event Settings description: >- Retrieve event configuration such as fields, tags, tracks, rooms, formats, levels, languages, and session statuses. - name: GDPR description: Manage GDPR data access and erasure requests. - name: Insights description: >- Query event data using SbQL, generate queries with AI, and manage dashboards. - name: Ask description: >- Ask a natural-language question about one event and get a cited answer. Requires the `read:ask` scope, granted explicitly. - name: Metadata Writes description: >- Create, update, and delete session metadata (rooms, tracks, tags, formats, levels, languages, statuses). Requires the `write:metadata` scope. - name: Agenda Planning description: >- Manage agenda drafts, draft sessions, scheduling rules, and evaluation personas. Requires the `write:events` scope. - name: Dashboards & Widgets description: >- Create, read, update, and delete dashboards and widgets at the event or organization level. Requires `write:events` scope for writes. - name: Reports & Queries description: >- Create, read, update, delete, and run saved SbQL queries/reports at the event or organization level. Requires `write:events` scope for writes. - name: Transcriptions description: >- Transcript text on sessions — fragments, summaries, insights, and translations. Requires `read:transcriptions` / `write:transcriptions` scopes. - name: Session Recordings description: >- Session audio files for recording archives (live capture or imported audio). Requires `read:transcriptions` / `write:transcriptions` scopes. - name: Media description: >- Upload video or audio files for automatic transcription. Requires `read:media` / `write:media` scopes. - name: Session Files description: > Documents attached to sessions (PDFs, PowerPoint, Word, images, and similar). Simple upload: `POST .../files/upload` (multipart, max 50 MB). Direct-to-storage: create → PUT → complete (max 500 MB). Requires `read:sessions` / `write:sessions` scopes. See the [Uploading session files](/guides/uploading-session-files) guide. - name: OAuth description: >- OAuth 2.1 endpoints for AI client authorization (Claude, ChatGPT). Mounted at `/oauth/` (not `/v1/`). - name: Log Export description: > Pull your organization's API request, security and audit logs into a SIEM such as Splunk, Microsoft Sentinel or Elastic. Requires a dedicated API token with the `read:audit_logs` scope, which can call nothing else. See the [Exporting logs to a SIEM](/guides/exporting-logs-to-a-siem) guide. - name: Awards description: >- Read and manage Awards programs and their categories, rounds, promo codes, submissions and reviews. Organization-level: paths start at `/v1/organization/{orgId}/awards`. Requires `read:awards` / `write:awards` scopes. - name: Registration description: > Registration inside Sessionboard: registration forms, ticket types, registrations, orders, attendees and check-ins for one event. Requires the preview scopes `read:registrations` / `write:registrations`, which a token or OAuth client gets only when they are named explicitly (not by default, and not listed in `scopes_supported`). The event must have Registration turned on (Early Access); otherwise every endpoint answers `403 FORBIDDEN`. See the [Registration and Expo](/guides/registration-and-expo) guide. - name: Expo description: > Expo floor-map booths and sponsorship inventory for one event. Requires the preview scopes `read:expo` / `write:expo`, which a token or OAuth client gets only when they are named explicitly (not by default, and not listed in `scopes_supported`). The event must have Expo turned on (Early Access); otherwise every endpoint answers `403 FORBIDDEN`. See the [Registration and Expo](/guides/registration-and-expo) guide. paths: /v1/event/{eventId}/registrations: post: tags: - Registration summary: Create a registration description: > Place an order on the integrator's behalf: one order for one or more people, each with a ticket type, through one of the event's registration forms. Use it to bring in registrations taken somewhere else, or to add comps and invoiced registrations. **This creates.** `POST /registrations` is not a search. `payment` says how the order is paid: | `payment` | Order status | Order `payment_method` | | --- | --- | --- | | `comp` | `paid`, total `0` — every line is fully discounted | `comp` | | `invoice` | `awaiting_invoice` (or `paid` when the total is `0`) | `invoice` | | `paid_externally` | `paid` — the money was taken in another system | `external` | | `cash` | `paid` | `cash` | | `check` | `paid` | `check` | The order goes through the same checks as a registration on the form: each ticket type must be sold on the form and on sale, capacity and per-order limits apply, the form's required questions must be answered, and an email can be registered for the event only once. The form's open and close dates do **not** apply, and `invoice` is accepted even if the form does not offer pay-later. Each registration is `confirmed`, or `pending_approval` when the event's approval rules hold it. **Idempotency.** Send an `idempotency_key` (a string of 1–128 characters) unique to the order in your system. Repeating a request with a key the event has already seen returns the original order and registrations with `200` instead of `201`, and creates nothing — even if the rest of the body differs. Recorded in the event's History as an API change. Requires `write:registrations`. operationId: create-registration parameters: - $ref: '#/components/parameters/EventId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RegistrationCreateRequest' example: form_id: 6c1f2d9e-3b4a-4f5e-8a7b-1c2d3e4f5a6b payment: paid_externally idempotency_key: crm-order-58213 external_reference: CRM order 58213 purchaser: email: events@northwind.example first_name: Sam last_name: Ortiz company: Northwind Health attendees: - email: priya.raman@example.org first_name: Priya last_name: Raman company: Northwind Health job_title: Clinical Director ticket_type_id: 0b9d6a3c-2e1f-4a5b-9c8d-7e6f5a4b3c2d answers: dietary_requirements: Vegetarian responses: '200': description: > Idempotent replay — an order with this `idempotency_key` already exists on the event. The original order and its registrations are returned; nothing is created. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/RegistrationCreateResult' '201': description: Created — the order and one registration per entry in `attendees`. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/RegistrationCreateResult' '400': description: > `VALIDATION_ERROR`: - `payment` is not `comp`, `invoice`, `paid_externally`, `cash` or `check`. - `form_id` is not a UUID. - `attendees` is missing or empty, has more than 100 entries, or an entry has no `email` or no UUID `ticket_type_id`. - `idempotency_key` is not a string of 1–128 characters. - Answers are missing or invalid — `details.reason: answers_invalid`, with the problems in `details.errors`. content: application/json: schema: $ref: '#/components/schemas/RegistrationApiError' examples: bad_payment: summary: Unknown payment value: error: VALIDATION_ERROR message: >- 'payment' must be comp, invoice, paid_externally, cash or check bad_attendee: summary: Attendee without a ticket type value: error: VALIDATION_ERROR message: attendees[0] needs an email and a ticket_type_id '401': $ref: '#/components/responses/RegistrationUnauthorized' '403': $ref: '#/components/responses/RegistrationForbidden' '404': description: '`NOT_FOUND` — no such form on this event.' content: application/json: schema: $ref: '#/components/schemas/RegistrationApiError' '409': description: > `CONFLICT` — the order cannot be placed. `details.reason` says why: - `duplicate` — an email is already registered for the event, or appears twice in `attendees` (`details.errors.email` names it). - `sold_out` — a ticket type has no seats left (`details.errors.ticket_type_id`). - `too_many` — more of a ticket type than its per-order maximum. - `ticket_unavailable` — a ticket type or add-on is not sold on this form. - `not_on_sale` — a ticket type is outside its sales dates. - `registrant_type_unavailable` — the form does not offer that registrant type. content: application/json: schema: $ref: '#/components/schemas/RegistrationApiError' example: error: CONFLICT message: priya.raman@example.org is already registered. details: reason: duplicate errors: email: priya.raman@example.org '422': description: | `VALIDATION_ERROR` — the `discount_code` is not valid for this order (`details.reason: discount_invalid`). content: application/json: schema: $ref: '#/components/schemas/RegistrationApiError' example: error: VALIDATION_ERROR message: That promo code is not valid. details: reason: discount_invalid errors: reason: not_found '429': $ref: '#/components/responses/RegistrationTooManyRequests' components: parameters: EventId: name: eventId in: path required: true schema: type: integer description: Event ID schemas: RegistrationCreateRequest: type: object required: - form_id - payment - attendees properties: form_id: type: string format: uuid description: >- The registration form to place the order through. Its ticket types, registrant types and questions apply. payment: type: string enum: - comp - invoice - paid_externally - cash - check description: How the order is paid. See the table above. idempotency_key: type: string minLength: 1 maxLength: 128 description: >- Your unique key for this order. A repeat with the same key returns the original order with `200`. external_reference: type: string maxLength: 200 description: >- Your reference for the order (for example your order number). Stored as the order's note. discount_code: type: string description: A promo code configured on the event. purchaser: type: object description: Who placed the order. Defaults to the first attendee. properties: email: type: string format: email first_name: type: string last_name: type: string company: type: string attendees: type: array minItems: 1 maxItems: 100 description: One entry per person, at most 100 per order. items: $ref: '#/components/schemas/RegistrationAttendeeInput' RegistrationCreateResult: type: object properties: order: $ref: '#/components/schemas/Order' registrations: type: array items: $ref: '#/components/schemas/Registration' RegistrationApiError: type: object description: Error body of the Registration and Expo endpoints. required: - error - message properties: error: type: string enum: - VALIDATION_ERROR - NOT_FOUND - FORBIDDEN - CONFLICT - SCOPE_REQUIRED - EVENT_NOT_ALLOWED - EVENT_ARCHIVED - INTERNAL_ERROR message: type: string details: type: object description: Present when there is a machine-readable reason. properties: reason: type: string description: > Why the request was refused, for example `duplicate`, `sold_out`, `too_many`, `ticket_unavailable`, `not_on_sale`, `registrant_type_unavailable`, `answers_invalid`, `discount_invalid`, `wrong_status`, `account_required` or `booth_not_found`. status: type: string description: >- For `wrong_status` on Check someone in, the registration's current status. errors: type: object additionalProperties: true description: >- More detail for some reasons — the email for `duplicate`, the `ticket_type_id` for `sold_out`, the problems per answer for `answers_invalid`. RegistrationAttendeeInput: type: object required: - email - ticket_type_id properties: email: type: string format: email first_name: type: string last_name: type: string company: type: string job_title: type: string ticket_type_id: type: string format: uuid description: Must be sold on the form. registrant_type_id: type: - string - 'null' format: uuid description: >- Must be offered on the form. Decides the price when the ticket type prices by registrant type. addon_ids: type: array items: type: string format: uuid description: Add-on ticket types for this person. session_ids: type: array items: type: string description: Sessions to reserve or pay for (session fees). answers: type: object additionalProperties: true description: >- Answers to the form's questions, keyed by the question's field `internal_name` or field ID. consent: type: boolean default: true Order: type: object description: An order and what it bought. Amounts are in the smallest currency unit. properties: id: type: string format: uuid number: type: - string - 'null' description: The order number shown to the purchaser and organizers. event_id: type: integer status: type: string enum: - draft - pending_payment - awaiting_invoice - paid - partially_refunded - refunded - canceled - expired purchaser: type: object properties: type: type: - string - 'null' enum: - contact - account - attendee - guest - null id: type: - string - 'null' email: type: - string - 'null' name: type: - string - 'null' company: type: - string - 'null' currency: type: string subtotal_cents: type: integer discount_cents: type: integer tax_cents: type: integer total_cents: type: integer paid_cents: type: integer balance_cents: type: integer description: '`total_cents - paid_cents`, never below `0`.' payment_method: type: - string - 'null' description: >- `card` for orders paid online; `comp`, `invoice`, `external`, `cash` or `check` for orders placed by organizers or through this API. discount: type: - object - 'null' properties: id: type: string code: type: string lines: type: array items: $ref: '#/components/schemas/OrderLine' registrations: type: array description: >- The registrations the order bought. Empty in the `order` returned by Create a registration — read `registrations` beside it. items: type: object properties: id: type: string format: uuid status: type: string first_name: type: - string - 'null' last_name: type: - string - 'null' email: type: string awaiting_assignment: type: boolean invoice: type: - object - 'null' additionalProperties: true description: The invoice, for orders paid by invoice. form_id: type: - string - 'null' format: uuid account_id: type: - string - 'null' format: uuid payment_mode: type: - string - 'null' created_at: type: string format: date-time Registration: type: object description: One person's registration for the event. properties: id: type: string format: uuid event_id: type: integer status: type: string enum: - incomplete - pending_approval - waitlisted - confirmed - checked_in - canceled - transferred - declined - no_show first_name: type: - string - 'null' last_name: type: - string - 'null' email: type: string company: type: - string - 'null' job_title: type: - string - 'null' ticket_type: type: - object - 'null' properties: id: type: string format: uuid name: type: string registrant_type: type: - object - 'null' properties: id: type: string format: uuid name: type: string form: type: - object - 'null' properties: id: type: string format: uuid name: type: string kind: type: string order_id: type: - string - 'null' format: uuid account_id: type: - string - 'null' format: uuid description: >- The exhibitor or sponsor account the person registered under (booth staff). contact_id: type: - string - 'null' description: The person's contact in Sessionboard. badge_id: type: - string - 'null' answers: type: object additionalProperties: true description: >- Answers to the form's questions beyond name, email, company and job title, keyed by the question's field `internal_name`. session_ids: type: array items: type: string description: Sessions the person reserved or paid for. membership: type: - object - 'null' additionalProperties: true description: >- The membership check made at registration, when the event verifies membership. awaiting_assignment: type: boolean description: >- `true` for a seat bought by a group purchaser and not yet assigned to a person. checked_in_at: type: - string - 'null' format: date-time badge: type: object properties: printed: type: boolean print_count: type: integer last_printed_at: type: - string - 'null' format: date-time approval: type: - object - 'null' description: >- The approval request for this registration, when the event's approval workflow opened one. properties: id: type: string status: type: string created_at: type: string format: date-time updated_at: type: string format: date-time description: >- When the registration last changed. `updated_since` on List registrations filters on it. OrderLine: type: object properties: key: type: string line_item_id: type: string format: uuid ticket_type_id: type: - string - 'null' format: uuid type: type: - string - 'null' description: The ticket type's `type` (`ticket`, `addon`, …). label: type: - string - 'null' tier_label: type: - string - 'null' description: The price tier applied (for example Early bird). quantity: type: integer unit_price_cents: type: integer discount_cents: type: integer tax_cents: type: integer total_cents: type: integer attendee_index: type: - integer - 'null' description: Which entry of the order's attendees this line is for. session_id: type: - string - 'null' gl_code: type: - string - 'null' responses: RegistrationUnauthorized: description: >- Missing, invalid or expired token, or the event does not belong to your organization. RegistrationForbidden: description: > - `SCOPE_REQUIRED` — the token lacks the scope (`read:registrations` for reads, `write:registrations` for writes). A write scope does not grant reads, and legacy tokens with no scopes cannot write. - `EVENT_NOT_ALLOWED` — the event is outside the token's event allow-list. - `EVENT_ARCHIVED` — the event is archived. - `FORBIDDEN` — Registration is not turned on for this event. content: application/json: schema: $ref: '#/components/schemas/RegistrationApiError' examples: feature_off: summary: Registration is off for the event value: error: FORBIDDEN message: Registration is not enabled for this event scope_required: summary: Token lacks the write scope value: error: SCOPE_REQUIRED message: This operation requires the 'write:registrations' scope. RegistrationTooManyRequests: description: | The token's request limit (100 requests per 15 minutes per bucket — see [Rate Limiting](/rate-limiting)). Wait `Retry-After` seconds. headers: Retry-After: description: Seconds to wait before retrying. schema: type: integer securitySchemes: ApiKey: type: apiKey in: header name: x-access-token description: >- Organization API token. Generate from Organization Settings → API Tokens. BearerToken: type: http scheme: bearer description: >- OAuth 2.1 access token. Obtained via the OAuth PKCE flow at `/oauth/token`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.