v1
latestOpenAPI 3.0.02026-07-24102143224.1 KBCustomers
List customers
get/v3/customers
Query parameters
pagenumber required
Page Number
limitnumber required
Number of items to return
filterstring
Format: field:rule:value — comma-separated for multiple filters.
Fields: name (string): eq, neq, like, nlike, in, nin, isnull, isnotnull externalIds.externalId (string): eq, neq, like, nlike, in, nin, isnull, isnotnull lastUpdatedAt (datetime): eq, neq, gt, gte, lt, lte customerCustomFields.defaultValue (string): eq, neq, like, nlike, in, nin, isnull, isnotnull
Date-only values (YYYY-MM-DD) match the full UTC day.
Example: filter=name:eq:value
Response
Get all Customers by filter
Example response
{
"payload": {
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Acme Inc.",
"parentCustomerId": "123e4567-e89b-12d3-a456-426614174000",
"defaultCurrency": "USD",
"primaryBillingContactName": "John Doe",
"primaryBillingContactEmail": "john.doe@example.com",
"secondaryBillingContacts": [
"jane.doe@example.com",
"jim.doe@example.com"
],
"billingAddress": {
"externalId": "10",
"city": "New York",
"state": "NY",
"country": "US",
"postalCode": "10001",
"line1": "123 Main St",
"line2": "Apt 1",
"addressee": "John Doe"
},
"shippingAddress": {
"externalId": "10",
"city": "New York",
"state": "NY",
"country": "US",
"postalCode": "10001",
"line1": "123 Main St",
"line2": "Apt 1",
"addressee": "John Doe"
},
"externalIds": [
{
"type": "NETSUITE",
"id": "123e4567-e89b-12d3-a456-426614174000"
}
],
"lastUpdatedAt": "2024-01-01T00:00:00.000Z",
"autoCharge": true,
"customerTaxInfo": {
"vatId": "DE123456789",
"ein": "12-3456789"
}
}
]
}
}