Skip to main content
GET
/
v0
/
customers
List by Merchant
curl --request GET \
  --url https://api.paygentic.io/v0/customers \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "id": "cus_p1q2r3s4t5u6v7w8",
      "object": "customer",
      "consumerId": "org_x9y0z1a2b3c4d5e6",
      "createdAt": "2024-02-05T11:30:00Z",
      "merchantId": "org_f7g8h9i0j1k2l3m4",
      "organization": {
        "id": "org_x9y0z1a2b3c4d5e6",
        "address": {
          "city": "San Francisco",
          "country": "US",
          "line1": "123 Main St",
          "state": "CA",
          "zipCode": "94105"
        },
        "billingEmails": [
          "billing@techcorp.com"
        ],
        "name": "TechCorp",
        "phone": "+1-555-123-4567"
      },
      "taxId": null,
      "taxRates": {
        "default": 8.5
      },
      "updatedAt": "2024-02-10T14:20:00Z",
      "validTaxAddress": {
        "message": null,
        "valid": true
      }
    }
  ],
  "pagination": {
    "limit": 10,
    "offset": 0,
    "total": 1
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication

Query Parameters

​
limit
integer
default:10

Number of customers to return

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of customers to skip

Required range: x >= 0
​
name
string

Filter customers by consumer name (case-insensitive substring match). Minimum 3 characters required for efficient index usage.

Required string length: 3 - 255
​
email
string

Filter customers by billing email (case-insensitive substring match). Minimum 3 characters required for efficient index usage. Accepts partial values — e.g. a domain ("acme.com") or local part ("billing").

Required string length: 3 - 255
​
externalId
string

Filter customers by exact external ID match.

Maximum string length: 255
​
organizationId
string
required

ID of the merchant organization to filter customers by Unique identifier for an organization

Pattern: ^org_[a-zA-Z0-9]+$

Response

List of customers retrieved successfully

​
object
enum<string>
required
Available options:
list
​
data
object[]
required
​
pagination
object
required

Offset-based pagination response.