> ## Documentation Index
> Fetch the complete documentation index at: https://docs.marzipan.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Waitlist Status

> Look up a customer's waitlist status for an event by email. For pending entries, the response includes the position and the number of people ahead; for promoted entries, it includes the expiry time and whether the spot can be claimed.



## OpenAPI

````yaml /api-reference/openapi.json get /events/{product}/waitlist/status
openapi: 3.0.0
info:
  title: Marzipan API
  version: 1.0.0
servers:
  - url: https://api.marzipan.co/v1
security:
  - tenantAuth: []
tags:
  - name: Account
    description: >-
      Account management endpoints including registration, login, and user
      details
  - name: Carts
    description: Shopping cart management endpoints
  - name: Products
    description: Product catalog and search endpoints
  - name: Subscriptions
    description: Subscription management and renewal endpoints
  - name: CMS
    description: Content management system endpoints
  - name: Messaging
    description: Message and communication endpoints
  - name: Search
    description: Search functionality endpoints
  - name: Settings
    description: >-
      Storefront settings and market detection used to configure the web
      components and checkout.
  - name: Analytics
    description: Storefront visit and attribution tracking.
  - name: Rewards
    description: >-
      Loyalty and rewards programme endpoints for the authenticated customer,
      covering points balance, tier status, perks, exclusive products and
      transaction history.
  - name: Forms
    description: Render and submit dynamic storefront forms defined in the CMS.
  - name: Events
    description: >-
      Check event availability, browse occurrences and recurring dates, generate
      ticket QR codes, and manage event waitlists (join, leave, check status,
      and claim promoted spots).
paths:
  /events/{product}/waitlist/status:
    parameters:
      - name: product
        in: path
        required: true
        description: The unique identifier of the event product.
        schema:
          type: string
          format: uuid
        example: 3f1c9d20-5b8e-4c11-a2d7-6e9f0a1b2c3d
    get:
      tags:
        - Events
      summary: Get Waitlist Status
      description: >-
        Look up a customer's waitlist status for an event by email. For pending
        entries, the response includes the position and the number of people
        ahead; for promoted entries, it includes the expiry time and whether the
        spot can be claimed.
      parameters:
        - name: email
          in: query
          required: true
          description: The email address to look up on the waitlist.
          schema:
            type: string
            format: email
          example: alex@example.com
      responses:
        '200':
          description: The customer's waitlist status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WaitlistStatus'
              example:
                success: true
                onWaitlist: true
                status: pending
                quantity: 2
                position: 4
                ahead: 3
        '404':
          description: The email address was not found on the waitlist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                message: Not found on waitlist
        '422':
          description: Validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
              example:
                message: The email field is required.
                errors:
                  email:
                    - The email field is required.
components:
  schemas:
    WaitlistStatus:
      type: object
      description: A customer's waitlist status for an event.
      properties:
        success:
          type: boolean
        onWaitlist:
          type: boolean
          description: Whether the customer is on the waitlist.
        status:
          type: string
          enum:
            - pending
            - promoted
            - claimed
            - expired
            - cancelled
          description: The entry status.
        quantity:
          type: integer
          description: The number of tickets requested.
        position:
          type: integer
          description: The waitlist position. Present for pending entries.
        ahead:
          type: integer
          description: The number of pending entries ahead. Present for pending entries.
        expiresAt:
          type: string
          format: date-time
          description: When the promoted spot expires. Present for promoted entries.
        canClaim:
          type: boolean
          description: >-
            Whether the promoted spot can currently be claimed. Present for
            promoted entries.
    Error:
      type: object
      properties:
        message:
          type: string
          description: Error message
      required:
        - message
    ValidationError:
      type: object
      properties:
        message:
          type: string
          description: Validation error message
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Field-specific validation errors
      required:
        - message
        - errors
  securitySchemes:
    tenantAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer authentication header of the form `Bearer <token>`, where
        `<token>` is your API token.
      bearerFormat: JWT

````