ServiceCustomerListResponse

successbooleanrequired

Always true on a 2xx response.

Example: true

data object[]required

One page of customers.

Array [

idstring<uuid>required

Customer id. Use it as customerId when creating quotes and orders.

Example: 5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b

codestringnullablerequired

Customer code.

Example: CUST-0001

customerCodestringnullablerequired

Customer account number.

Example: CA-0001

namestringnullablerequired

Name.

Example: Example Trading Co

displayNamestringnullablerequired

Display name.

Example: Example Trading

legalNamestringnullablerequired

Registered legal name.

Example: Example Trading Company Ltd

taxIdstringnullablerequired

Tax registration number.

Example: TAX-000000

statusstringnullablerequired

Account status.

Possible values: [ACTIVE, INACTIVE, PENDING_APPROVAL, null]

paymentTermsstringnullablerequired

Default payment terms code.

Example: NET_30

currencystringnullablerequired

Preferred ISO 4217 currency code.

Example: USD

creditLimitnumbernullablerequired

Credit limit in the workspace currency. Zero or less means unlimited.

Example: 5000

availableCreditnumbernullablerequired

Credit still available, in the workspace currency.

Example: 3200

taxExemptbooleannullablerequired

True when the customer is exempt from tax; null when no account exists.

Example: false

defaultWarehouseIdstring<uuid>nullablerequired

Default warehouse for the customer's orders.

Example: 9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d

addresses object[]required

Saved addresses.

Array [

idstring<uuid>required

Address id.

Example: 5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b

typestringnullablerequired

What the address is used for.

Possible values: [BILLING, SHIPPING, WAREHOUSE, OFFICE, HOME, PICKUP, DELIVERY, RETURN, null]

labelstringnullablerequired

Short label.

Example: Head office

street1stringnullablerequired

Street, line 1.

Example: 1 Example Street

street2stringnullablerequired

Street, line 2.

Example: Suite 100

citystringnullablerequired

City.

Example: Exampleville

statestringnullablerequired

State or province.

Example: Example State

countrystringnullablerequired

Country.

Example: Exampleland

postalCodestringnullablerequired

Postal code.

Example: 12345

isDefaultbooleanrequired

True for the customer's default address of its type.

Example: true

isBranchbooleanrequired

True when the address is a branch location.

Example: false

isActivebooleannullablerequired

False when the address is retired.

Example: true

]

contacts object[]required

Contact details.

Array [

typestringnullablerequired

Contact kind, such as EMAIL or PHONE.

Example: EMAIL

valuestringnullablerequired

The email address, phone number or other value.

Example: buyer@example.com

namestringnullablerequired

Name of the person.

Example: Sample Buyer

isDefaultbooleanrequired

True for the customer's default contact of its type.

Example: true

]

deletedbooleanrequired

Always present. True only for a removed customer, which a delta pull (updatedAfter) returns so a sync can drop the row.

Example: false

updatedAtstring<date-time>nullablerequired

When the customer last changed.

Example: 2026-01-15T09:30:00.000Z

]

page objectrequired

Paging state.

hasMorebooleanrequired

True when more rows follow this page.

Example: true

nextCursorstringnullablerequired

Opaque cursor. Pass it back as the cursor query parameter to fetch the next page; null on the last page.

Example: bzo1MA

ServiceCustomerListResponse

{
  "success": true,
  "data": [
    {
      "id": "5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b",
      "code": "CUST-0001",
      "customerCode": "CA-0001",
      "name": "Example Trading Co",
      "displayName": "Example Trading",
      "legalName": "Example Trading Company Ltd",
      "taxId": "TAX-000000",
      "status": "ACTIVE",
      "paymentTerms": "NET_30",
      "currency": "USD",
      "creditLimit": 5000,
      "availableCredit": 3200,
      "taxExempt": false,
      "defaultWarehouseId": "9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d",
      "addresses": [
        {
          "id": "5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b",
          "type": "BILLING",
          "label": "Head office",
          "street1": "1 Example Street",
          "street2": "Suite 100",
          "city": "Exampleville",
          "state": "Example State",
          "country": "Exampleland",
          "postalCode": "12345",
          "isDefault": true,
          "isBranch": false,
          "isActive": true
        }
      ],
      "contacts": [
        {
          "type": "EMAIL",
          "value": "buyer@example.com",
          "name": "Sample Buyer",
          "isDefault": true
        }
      ],
      "deleted": false,
      "updatedAt": "2026-01-15T09:30:00.000Z"
    }
  ],
  "page": {
    "hasMore": true,
    "nextCursor": "bzo1MA"
  }
}