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

# List API keys

> Returns a paginated list of API keys for an organisation.



## OpenAPI

````yaml /api-reference/external/openapi.yaml get /public/api-keys
openapi: 3.0.3
info:
  title: PCX API
  description: >
    The PCX integration API. Every request requires two headers: `Authorization`
    (Bearer JWT for user-facing flows, or the literal string `NONE`) and
    `X-Api-Key` (your API key for server-to-server calls, or the literal string
    `NONE`). Pass `NONE` for whichever header you are not using.
  version: '1.0'
servers:
  - url: https://prod-api.pcxpay.com/v1
    description: Production
  - url: https://devs.pcxpay.com/v1
    description: Development
security: []
tags:
  - name: Payment Initiation
    description: Initiate payments and poll for status
  - name: API Keys
    description: Create and manage API keys for programmatic access
  - name: Webhooks
    description: Register endpoints and receive transaction notifications
  - name: Beneficiaries
    description: Manage payment recipients
  - name: Payments
    description: Initiate and track payments
  - name: Bank Validation
    description: Validate bank accounts before initiating a payment
  - name: Transactions
    description: Query the financial transaction ledger
  - name: Virtual Accounts
    description: Multi-currency virtual account provisioning and fund operations
  - name: Payment Links
    description: Generate shareable payment links for customer checkout
  - name: Escrow
    description: Milestone-based escrow projects, parties, contracts, and funding
paths:
  /public/api-keys:
    parameters:
      - $ref: '#/components/parameters/AuthorizationHeader'
      - $ref: '#/components/parameters/XApiKeyHeader'
    get:
      tags:
        - API Keys
      summary: List API keys
      description: Returns a paginated list of API keys for an organisation.
      operationId: listApiKeys
      parameters:
        - name: org_id
          in: query
          required: true
          schema:
            type: string
          description: Organisation whose keys to list
        - name: limit
          in: query
          schema:
            type: integer
            default: 20
            minimum: 1
            maximum: 100
        - name: last_evaluated_key
          in: query
          schema:
            type: string
          description: >-
            Pagination cursor from the previous response's
            `meta.last_evaluated_key`.
      responses:
        '200':
          description: Paginated list of API keys
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyListResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  parameters:
    AuthorizationHeader:
      name: Authorization
      in: header
      required: true
      description: >-
        Bearer JWT for user-facing flows (`Bearer eyJraWQ...`), or the literal
        string `NONE` when authenticating via API key.
      schema:
        type: string
        default: NONE
        example: Bearer eyJraWQ...
    XApiKeyHeader:
      name: X-Api-Key
      in: header
      required: true
      description: >-
        API key for server-to-server flows, or the literal string `NONE` when
        authenticating via JWT.
      schema:
        type: string
        default: NONE
        example: pcx_abc123_xxxx
  schemas:
    ApiKeyListResponse:
      allOf:
        - $ref: '#/components/schemas/StandardResponse'
        - type: object
          properties:
            data:
              type: array
              items:
                $ref: '#/components/schemas/ApiKey'
            meta:
              $ref: '#/components/schemas/CursorMeta'
    StandardResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
            - error
          example: success
        message:
          type: string
    ApiKey:
      type: object
      properties:
        api_key_id:
          type: string
        prefix:
          type: string
          example: pcx_abc123
        name:
          type: string
        org_id:
          type: string
        user_id:
          type: string
        status:
          $ref: '#/components/schemas/ApiKeyStatus'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    CursorMeta:
      type: object
      properties:
        count:
          type: integer
        total_count:
          type: integer
        last_evaluated_key:
          type: string
          nullable: true
          description: Pagination cursor; null when no further pages exist.
        has_more:
          type: boolean
    ErrorResponse:
      type: object
      properties:
        message:
          type: string
        status:
          type: string
          enum:
            - error
    ApiKeyStatus:
      type: string
      enum:
        - active
        - inactive
        - revoked
      example: active
  responses:
    Unauthorized:
      description: Missing or invalid credentials
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'

````