> ## 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 users for the authenticated partner

> 
Retrieve paginated list of users in the partner organization.

**Authentication:** Requires valid Partner API Key in Authorization header (Bearer token).

**Includes:** Primary partner user, event organizers, and verifiers.

**Filters:**
- `role`: Filter by user role (organiser, verifier, user, admin)
- `search`: Search by email or name
- `page`: Page number (default: 1)
- `limit`: Items per page (default: 20)
    



## OpenAPI

````yaml /partner-docs/openapi.json get /partners/users
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/users:
    get:
      tags:
        - Partner Users
      summary: List users for the authenticated partner
      description: >-

        Retrieve paginated list of users in the partner organization.


        **Authentication:** Requires valid Partner API Key in Authorization
        header (Bearer token).


        **Includes:** Primary partner user, event organizers, and verifiers.


        **Filters:**

        - `role`: Filter by user role (organiser, verifier, user, admin)

        - `search`: Search by email or name

        - `page`: Page number (default: 1)

        - `limit`: Items per page (default: 20)
            
      operationId: PartnerUsersController_listUsers
      parameters:
        - name: search
          required: false
          in: query
          description: Search by email or name
          schema:
            type: string
        - name: role
          required: false
          in: query
          description: Filter by user role
          schema:
            enum:
              - user
              - verifier
              - support
              - finance
              - organiser
              - admin
              - super_admin
            type: string
        - 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 users
          content:
            application/json:
              schema:
                type: object
                properties:
                  users:
                    type: array
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                        email:
                          type: string
                        nick_name:
                          type: string
                        role:
                          type: string
                          enum:
                            - user
                            - organiser
                            - verifier
                            - admin
                        is_verified:
                          type: boolean
                        created:
                          type: string
                          format: date-time
                  total:
                    type: number
                  page:
                    type: number
                  limit:
                    type: number
        '401':
          description: Invalid or missing partner API key
      security:
        - partner-api-key: []
components:
  securitySchemes:
    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.