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

# List events



## OpenAPI

````yaml /partner-docs/openapi.json get /partners/events
openapi: 3.0.0
info:
  title: Tickify Partner API
  description: >2-

        API documentation for the Tickify Partner Platform.

        Getting Started:
    1. Register as a partner and wait for approval from the Tickify team.
        2. Once approved, request an API key from the Tickify team. A Tickify admin will generate and securely share your API key with you.
        3. Use your API key to authenticate partner API requests.
        4. Generate an access token using the /partner/auth/token endpoint in the Auth documentation.
        5. Use the access token for authenticated requests where required.

        **API Keys:**
    - Test keys use the 

    `tk_test_` prefix. These keys work in sandbox mode and never charge real
    payment methods.

    - Live keys use the 

    `tk_live_` prefix. These keys process real payments and require completed
    Stripe Connect onboarding.

    - Both key types follow the same API behavior — only the payment environment
    differs.

    - To test checkout flows without real charges, use 

    `tk_test_` keys and include test card numbers in your Stripe integration.
        
  version: '1.0'
  contact: {}
servers:
  - url: http://localhost:3000
    description: Local Development
  - url: https://api-staging.tickify.io
    description: Staging
  - url: https://api.tickify.io
    description: Production
security: []
tags: []
paths:
  /partners/events:
    get:
      tags:
        - events-consumer
      summary: List events
      operationId: PartnerEventsController_listEvents
      parameters:
        - name: page_index
          required: false
          in: query
          description: Deprecated. Use page instead.
          schema:
            default: 1
            type: number
        - name: page_size
          required: false
          in: query
          description: Deprecated. Use limit instead.
          schema:
            default: 15
            type: number
        - name: sort_start_date
          required: false
          in: query
          schema:
            default: asc
            type: string
            enum:
              - asc
              - desc
        - name: title
          required: false
          in: query
          description: Search by event title
          schema:
            type: string
        - name: category
          required: false
          in: query
          schema:
            type: string
        - name: start_date
          required: false
          in: query
          schema:
            type: string
        - name: end_date
          required: false
          in: query
          schema:
            type: string
        - name: price_min
          required: false
          in: query
          schema:
            example: 0
            type: number
        - name: price_max
          required: false
          in: query
          schema:
            example: 1000
            type: number
        - name: location
          required: false
          in: query
          description: Filter by city, venue, or address name
          schema:
            example: Lagos
            type: string
        - name: status
          required: false
          in: query
          description: Filter by event status
          schema:
            enum:
              - PENDING
              - APPROVED
              - ENDED
              - CANCELLED
              - LIVE
            type: string
        - name: enable_waitlist
          required: false
          in: query
          description: Filter events based on waitlist configuration
          schema:
            type: boolean
        - name: limit
          required: false
          in: query
          description: 'Items per page (default: 20)'
          schema:
            type: number
        - name: page
          required: false
          in: query
          description: 'Page number (default: 1)'
          schema:
            type: number
      responses:
        '200':
          description: Paginated list of events
        '400':
          description: Invalid query parameters
        '401':
          description: Invalid or missing partner API key
        '422':
          description: Validation failed
      security:
        - access-token: []
        - partner-api-key: []
components:
  securitySchemes:
    access-token:
      scheme: bearer
      bearerFormat: JWT
      type: http
    partner-api-key:
      type: apiKey
      in: header
      name: x-partner-key
      description: Partner API Key (tk_live_... or tk_test_...)

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.