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

# List payers

> Retrieve payers with filtering and pagination



## OpenAPI

````yaml get /v1/payers
openapi: 3.0.0
info:
  title: Payers API
  version: 1.0.0
  description: API for managing invoice payers
servers: []
security:
  - bearerAuth: []
tags:
  - name: Payers
    description: Payer management operations
paths:
  /v1/payers:
    get:
      tags:
        - Payers
      summary: List payers
      description: Retrieve payers with filtering and pagination
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
          description: Maximum number of records to return
        - name: offset
          in: query
          schema:
            type: integer
            minimum: 0
            default: 0
          description: Number of records to skip
        - name: company
          in: query
          schema:
            type: string
          description: Filter by company name
        - name: country
          in: query
          schema:
            type: string
            pattern: ^[A-Z]{3}$
          description: Filter by ISO3 country code
        - name: active
          in: query
          schema:
            type: boolean
          description: Filter by active status
      responses:
        '200':
          description: List of payers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayersResponse'
components:
  schemas:
    PayersResponse:
      type: object
      properties:
        payers:
          type: array
          items:
            $ref: '#/components/schemas/Payer'
        total:
          type: integer
          description: Total number of records
        has_more:
          type: boolean
          description: Whether more records exist
    Payer:
      type: object
      properties:
        id:
          type: string
          format: uuid
        customer_id:
          type: string
          format: uuid
        email:
          type: string
          format: email
        name:
          type: string
        company:
          type: string
        country:
          type: string
          pattern: ^[A-Z]{3}$
        active:
          type: boolean
        metadata:
          type: object
          additionalProperties: true
        created_at:
          type: string
          format: date-time
        created_by:
          type: string
          format: uuid
        modified_at:
          type: string
          format: date-time
        modified_by:
          type: string
          format: uuid
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````