---
title: "List all customers"
method: GET
path: "/ar/customers"
tags: ["Customers"]
---

# List all customers

`GET /ar/customers`

Retrieve a paginated list of customers. Supports cursor-based pagination with limit, order, start_after, and end_before query parameters.

## Query parameters

- `limit` integer — Maximum number of results to return. Allowed range: 1 to 1000. Defaults to 1000
- `start_after` string, uuid — The ID of the customer to start the page after (exclusive). When provided, results will begin with the customer immediately following this ID. Use this for standard forward pagination to get the next page of results. Cannot be combined with end_before.
- `end_before` string, uuid — The ID of the customer to end the page before (exclusive). When provided, results will end just before this ID and work backwards. Use this for reverse pagination or to retrieve previous pages. Cannot be combined with start_after.
- `order` 'asc' | 'desc' — Sort order. Can be 'asc' or 'desc'. Defaults to 'asc'

## Response `200`

- ApiV1ArCustomerPaginatedResponseData — Paginated response data for Accounts Receivable customers API endpoint
  - `customers` ApiV1ArCustomerResponseData[], required — The list of customers for this page
    - `address` object, nullable — Address of customer.
      - `address1` string, required — Primary street address line.
      - `address2` string, nullable — Secondary street address line (optional).
      - `city` string, required — City name.
      - `country` string, required — Two-letter country code (ISO 3166-1 alpha-2).
      - `postalCode` string, required — Postal or ZIP code
      - `region` string, required — State, province, or region.
    - `deletedAt` string, yyyy-mm-ddThh:MM:ssZ, nullable — The time the customer was deleted, if it was deleted.
    - `email` string, required — Email of customer.
    - `id` string, uuid, required — ArCustomerId
    - `name` string, required — Name of customer.
  - `page` object, required — Pagination cursors for navigating to next/previous pages
    - `nextPage` string, uuid — The customer who will receive the invoice. Use the /api/v1/ar/customers endpoint to list your customers and find the corresponding id, or create a new customer first.
    - `previousPage` string, uuid — The customer who will receive the invoice. Use the /api/v1/ar/customers endpoint to list your customers and find the corresponding id, or create a new customer first.

## Other responses

- `400` — Invalid `order` or `end_before` or `start_after` or `limit`

---

[API](https://skmtc.net/mercurytechnologies/apis/mercury-api.md) · [All operations](https://skmtc.net/mercurytechnologies/apis/mercury-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mercurytechnologies/mercury-api/revisions/0bdf4a496e03/schema)