Eventship Registration API

openapi: 3.2.0
info:
  title: Eventship Com Registration API
  version: '1.0'
  description: 'Operations tagged Registration across 2 of this provider''s published API definitions: developer.eventship.com.json, eventship-com-openapi.json. Each path carries the servers of the definition it was published in.'
security:
- ApiKeyAuth: []
tags:
- name: Registration
paths:
  /v1/events/{event_slug}/register:
    post:
      tags:
      - Registration
      summary: Register Attendee
      description: 'Register an attendee for a free event.


        Only free tickets are supported via the API. For paid events,

        direct attendees to the event page on eventship.com.


        Ticket types that sell in packs are not supported either, and are refused

        with ``PACK_TICKET_UNSUPPORTED``: this endpoint creates a single

        registration, while one pack unit is worth several seats. That applies both

        when ``ticketTypeId`` names a pack and when auto-selection finds only packs.


        If the event has required registration questions, call

        ``GET /v1/events/{event_slug}/questions`` first to get them,

        then include answers in this request.'
      operationId: register_attendee_v1_events__event_slug__register_post
      parameters:
      - name: event_slug
        in: path
        required: true
        schema:
          type: string
          title: Event Slug
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalRegisterRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalRegistrationResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    ExternalRegisterRequest:
      properties:
        email:
          type: string
          title: Email
          description: Attendee email address (required)
        firstName:
          anyOf:
          - type: string
          - type: 'null'
          title: Firstname
        lastName:
          anyOf:
          - type: string
          - type: 'null'
          title: Lastname
        ticketTypeId:
          anyOf:
          - type: integer
          - type: 'null'
          title: Tickettypeid
        answers:
          items:
            $ref: '#/components/schemas/ExternalRegistrationAnswer'
          type: array
          title: Answers
          default: []
      additionalProperties: false
      type: object
      required:
      - email
      title: ExternalRegisterRequest
      description: 'Request to register an attendee via the external API.


        The host is resolved from the API key. Only free tickets are supported —

        paid tickets require the checkout flow on eventship.com.'
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ExternalRegistrationResponse:
      properties:
        status:
          type: string
          title: Status
        registrationId:
          type: string
          title: Registrationid
        email:
          type: string
          title: Email
        ticketType:
          anyOf:
          - type: string
          - type: 'null'
          title: Tickettype
      type: object
      required:
      - status
      - registrationId
      - email
      title: ExternalRegistrationResponse
      description: Registration result for external API consumers.
    ExternalRegistrationAnswer:
      properties:
        questionId:
          type: integer
          title: Questionid
        answerText:
          anyOf:
          - type: string
          - type: 'null'
          title: Answertext
        answerJson:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Answerjson
      additionalProperties: false
      type: object
      required:
      - questionId
      title: ExternalRegistrationAnswer
      description: Answer to a registration question for external API consumers.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Your host API key. Create one from your host dashboard settings.
x-refined-from:
- developer.eventship.com.json
- eventship-com-openapi.json