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

# List customers

`GET /v3/customers`

## Query parameters

- `page` number, required
- `limit` number, required
- `filter` string

## Response `200`

Get all Customers by filter

- object
  - `payload` object, required — Response payload, will be empty when success is false
    - `data` CustomerV3Dto[]
      - `id` string, required — Unique identifier for the customer
      - `name` string, required — Preferred company name
      - `parentCustomerId` string, required — Parent Customer Id
      - `defaultCurrency` string, required — Default currency code for the customer, if omitted will default to USD
      - `primaryBillingContactName` string, required — Name of primary billing contact
      - `primaryBillingContactEmail` string, required — Email of primary billing contact
      - `secondaryBillingContacts` string[], required — List of secondary billing contact emails
      - `billingAddress` AddressV3Dto
        - `externalId` string, required — External identifier for the address
        - `city` string, required — City name
        - `state` string, required — State/province name
        - `country` string — Country Code
        - `postalCode` string, required — Postal/ZIP code
        - `line1` string, required — Primary street address
        - `line2` string, required — Secondary address line (apt, suite, etc)
        - `addressee` string — Name of recipient/addressee
      - `shippingAddress` AddressV3Dto
        - `externalId` string, required — External identifier for the address
        - `city` string, required — City name
        - `state` string, required — State/province name
        - `country` string — Country Code
        - `postalCode` string, required — Postal/ZIP code
        - `line1` string, required — Primary street address
        - `line2` string, required — Secondary address line (apt, suite, etc)
        - `addressee` string — Name of recipient/addressee
      - `externalIds` ExternalIdV3Dto[] — List of external identifiers
        - `type` 'QUICKBOOKS' | 'NETSUITE' | 'RILLET' | 'SAGE_INTACCT' | 'SALESFORCE' | 'HUBSPOT' | 'AVALARA' | 'ANROK' | 'STRIPE', required
        - `id` string, required — External identifier value
      - `lastUpdatedAt` string, required — Timestamp of last update
      - `customFields` string[] — Customer's custom fields
      - `autoCharge` boolean — Whether auto charge is enabled for the customer. If true and customer has a default payment method defined in their billing settings, that payment method will be autocharged
      - `dunningDisabled` boolean — Whether reminder emails (dunning) are disabled for this customer. When true, no automated payment reminder emails will be sent to this customer. Note: The initial invoice email is still sent even when this is true.
      - `customerTaxInfo` CustomerTaxInfoV3Dto
        - `vatId` string — VAT identifier
        - `ein` string — EIN identifier
        - `isTaxExempt` boolean, required — Whether customer is tax exempt
    - `limit` number
    - `totalItems` number
    - `currentPage` number
  - `success` boolean, required — Boolean with true=success, false=failure
  - `message` string, required — Plain-text description of the result
  - `error` IntegratorsApiError, required
    - `code` number, required — API response code
    - `message` string, required — API response message
    - `details` object — Additional details about the error

---

[API](https://skmtc.net/tabsplatform/apis/tabs-external-api.md) · [All operations](https://skmtc.net/tabsplatform/apis/tabs-external-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tabsplatform/tabs-external-api/revisions/7e8885517814/schema)