v1

latestOpenAPI 3.1.02026-07-24170121.2 MB

List All Customers

This API returns a list of customers. The list is sorted by ‘creation date’ with the most recently created customers appearing first.

get/v1/customers

Query parameters

limitinteger

A number that represents the number of customers to be listed.

Response

200

Example response

{
  "data": [
    {
      "object": "customer",
      "customer_id": "ADjPnVDNMjMpVpMN",
      "name": "gdfgsf",
      "email": "eric.yulfo@payarc.com",
      "description": "fdsgdsg",
      "send_email_address": "eric.yulfo@payarc.com",
      "cc_email_address": "eric.yulfo@payarc.com",
      "address_1": "sdfgdsf",
      "address_2": "sdfgfdsg",
      "city": "sdgfsfdg",
      "state": "NY",
      "zip": "11501",
      "phone": "5555555555",
      "country": "sdfgfdsg",
      "created_at": 1724443729,
      "updated_at": 1724443729,
      "readable_created_at": "30 minutes ago",
      "readable_updated_at": "30 minutes ago",
      "invoice_prefix": "1MAA"
    }
  ],
  "meta": {
    "include": [
      "card"
    ],
    "pagination": {
      "total": 6,
      "count": 6,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 1
    }
  }
}
All 170 operations