> ## 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 all Custom From Addresses

> Fetch a list of all custom 'from' address records.



## OpenAPI

````yaml GET /customFromAddresses
openapi: 3.0.1
info:
  title: Online Check Writer API
  description: API documentation for retrieving all custom 'from' addresses.
  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:
  /customFromAddresses:
    get:
      tags:
        - Custom From Addresses
      summary: Retrieve All Custom From Addresses
      description: Fetch a list of all custom 'from' address records.
      parameters:
        - name: perPage
          in: query
          required: false
          description: Number of records to retrieve per page. Defaults to 10.
          schema:
            type: integer
            default: 10
            example: 20
        - name: page
          in: query
          required: false
          description: Page number for pagination. Defaults to the first page.
          schema:
            type: integer
            default: 1
            example: 2
      responses:
        '200':
          description: Custom 'from' addresses retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          total:
                            type: integer
                            example: 45
                      addresses:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: 5EJy7VeBQGzn1m3
                            name:
                              type: string
                              example: John
                            companyName:
                              type: string
                              nullable: true
                              example: Company A
                            addressLine1:
                              type: string
                              example: Address 1
                            addressLine2:
                              type: string
                              nullable: true
                              example: Address 2
                            city:
                              type: string
                              example: City
                            state:
                              type: string
                              example: ST
                            zip:
                              type: string
                              example: '123465'
                            phone:
                              type: string
                              nullable: true
                              example: ''
                            email:
                              type: string
                              nullable: true
                              example: example@test.com
                            note:
                              type: string
                              nullable: true
                              example: ''
              examples:
                exampleResponse:
                  value:
                    success: true
                    data:
                      meta:
                        total: 2
                      addresses:
                        - id: 5EJy7VeBQGzn1m3
                          name: John
                          companyName: Company Name
                          addressLine1: Address 1
                          addressLine2: Address 2
                          city: City
                          state: ST
                          zip: '123456'
                          phone: ''
                          email: example@example.com
                          note: ''
                        - id: ZqRmA345OegdoLl
                          name: John1
                          companyName: Company Name 1
                          addressLine1: Address 11
                          addressLine2: Address 21
                          city: City
                          state: ST
                          zip: '123456'
                          phone: '123456789'
                          email: ''
                          note: ''
        '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

````