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

# Get Payees

> List all payee records.



## OpenAPI

````yaml GET /payees
openapi: 3.0.1
info:
  title: Online Check Writer API
  description: API documentation for managing payees.
  version: 1.0.0
servers:
  - url: https://test.onlinecheckwriter.com/api/v3
    description: Test server
  - url: https://app.onlinecheckwriter.com/api/v3
    description: Production server
security: []
paths:
  /payees:
    get:
      tags:
        - Payees
      summary: Retrieve all payees
      description: List all payee records.
      parameters:
        - name: perPage
          in: query
          description: Number of records to retrieve per page. Default is 10.
          required: false
          schema:
            type: integer
            default: 10
            example: 10
        - name: page
          in: query
          description: Page number for paginated results. Default is 1.
          required: false
          schema:
            type: integer
            default: 1
            example: 1
        - name: term
          in: query
          description: Filter records using any keywords.
          required: false
          schema:
            type: string
            example: John
      responses:
        '200':
          description: Successful response with a list of payees.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          total:
                            type: integer
                            example: 100
                          currentPage:
                            type: integer
                            example: 1
                          perPage:
                            type: integer
                            example: 1
                      payees:
                        type: array
                        items:
                          type: object
                          properties:
                            payeeId:
                              type: string
                              example: RJ6qGAAxJPGE1rD
                            name:
                              type: string
                              example: John Doe
                            nickName:
                              type: string
                              example: JD
                            company:
                              type: string
                              example: Company A
                            email:
                              type: string
                              example: johndoe@example.com
                            phone:
                              type: string
                              example: '1234567890'
                            address1:
                              type: string
                              example: Address 1
                            address2:
                              type: string
                              example: Address 2
                            city:
                              type: string
                              example: City
                            state:
                              type: string
                              example: ST
                            zip:
                              type: string
                              example: '12345'
                            country:
                              type: string
                              example: US
        '401':
          description: Unauthorized. Missing or invalid token.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````