Eventship Attendees API

openapi: 3.2.0
info:
  title: Eventship Com Attendees API
  version: '1.0'
  description: 'Operations tagged Attendees 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: Attendees
paths:
  /v1/events/{event_slug}/attendees:
    get:
      tags:
      - Attendees
      summary: List Attendees
      description: 'List attendees for an event.


        Access rules:

        - Hosts of the event see the full attendee list (name, email, status,

        ticket type, check-in status, registration date). The ``status``

        filter applies, and ``includeAnswers=true`` adds each registrant''s

        registration-question answers.

        - Confirmed registered attendees see a filtered list (name + public

        profile info only) when the event has ``showGuestList=true``.

        Host-only fields are ``null``. Always limited to confirmed

        registrations; the ``status`` filter is ignored, and

        ``includeAnswers`` is refused.

        - API-key auth is always host-only (API keys are scoped to a host).'
      operationId: list_attendees_v1_events__event_slug__attendees_get
      parameters:
      - name: event_slug
        in: path
        required: true
        schema:
          type: string
          title: Event Slug
      - name: status
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by registration status (host only — ignored for non-host callers)
          title: Status
        description: Filter by registration status (host only — ignored for non-host callers)
      - name: includeAnswers
        in: query
        required: false
        schema:
          type: boolean
          description: Include each registrant's answers to the event's registration questions (host only). Off by default so existing integrations keep their current payload size.
          default: false
          title: Includeanswers
        description: Include each registrant's answers to the event's registration questions (host only). Off by default so existing integrations keep their current payload size.
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          default: 1
          title: Page
      - name: pageSize
        in: query
        required: false
        schema:
          type: integer
          maximum: 200
          minimum: 1
          default: 50
          title: Pagesize
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponse_ExternalAttendee_'
        '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
    PaginatedResponse_ExternalAttendee_:
      properties:
        data:
          items:
            $ref: '#/components/schemas/ExternalAttendee'
          type: array
          title: Data
        total:
          type: integer
          title: Total
        page:
          type: integer
          title: Page
        pageSize:
          type: integer
          title: Pagesize
          default: 20
        hasMore:
          type: boolean
          title: Hasmore
      type: object
      required:
      - data
      - total
      - page
      - hasMore
      title: PaginatedResponse[ExternalAttendee]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ExternalAttendee:
      properties:
        name:
          type: string
          title: Name
        profileSlug:
          anyOf:
          - type: string
          - type: 'null'
          title: Profileslug
        companyName:
          anyOf:
          - type: string
          - type: 'null'
          title: Companyname
        email:
          anyOf:
          - type: string
          - type: 'null'
          title: Email
        status:
          anyOf:
          - type: string
          - type: 'null'
          title: Status
        ticketType:
          anyOf:
          - type: string
          - type: 'null'
          title: Tickettype
        checkedIn:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Checkedin
        registeredAt:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Registeredat
        answers:
          anyOf:
          - items:
              $ref: '#/components/schemas/ExternalAttendeeAnswer'
            type: array
          - type: 'null'
          title: Answers
          description: This registrant's answers to the event's registration questions, in the questions' display order. Host view only, and only when the request sets `includeAnswers=true`; `null` otherwise. An answer appears once the registrant submitted it, whether the question is one of yours or one of Eventship's built-in profile questions.
      type: object
      required:
      - name
      title: ExternalAttendee
      description: 'Attendee info for external API consumers.


        Public fields (``name``, ``profileSlug``, ``companyName``) are always

        populated. Host-only fields (``email``, ``status``, ``ticketType``,

        ``checkedIn``, ``registeredAt``, ``answers``) are populated only when the

        caller is a host of the event; confirmed attendees viewing a public guest

        list see these as ``null``.'
    ExternalAttendeeAnswer:
      properties:
        questionId:
          type: integer
          title: Questionid
        questionKey:
          type: string
          title: Questionkey
        questionText:
          type: string
          title: Questiontext
        questionType:
          $ref: '#/components/schemas/QuestionType'
        isCustom:
          type: boolean
          title: Iscustom
          default: false
        answerText:
          anyOf:
          - type: string
          - type: 'null'
          title: Answertext
        answerJson:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Answerjson
          description: Selected values for multi-choice questions. Populated instead of `answerText` for `multiselect`, and for any answer stored as a list of selections.
      type: object
      required:
      - questionId
      - questionKey
      - questionText
      - questionType
      title: ExternalAttendeeAnswer
      description: 'One registrant''s answer to one of the event''s registration questions.


        Field names match ``ExternalRegistrationAnswer``, the shape a consumer POSTs

        to ``/register``, so an answer written through the API reads back under the

        same keys; the extra fields here are the question''s own metadata. It also

        mirrors ``MembershipAnswerSchema`` (``api/schemas/host_question.py``), the

        established host-facing answer payload, so the platform carries one answer

        shape rather than a per-surface invention. ``answerText`` is already

        display-formatted — an encoded company (``<uuid>|<name>``) and a JSON

        mailing address are rendered the same way the guest-list CSV renders them.


        A question''s identity is ``questionKey`` **plus** ``isCustom``: a host''s own

        question may carry a system key, so a consumer matching "this is the

        platform''s Company field" must test both.'
    QuestionType:
      type: string
      enum:
      - text
      - textarea
      - select
      - checkbox
      - multiselect
      - address
      title: QuestionType
      description: Type of registration question on an event.
  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