List customers

curl --request GET \
  --url https://base_url/api/v1/customers \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "customers": [
      {
        "id": "b6d009b0-d174-463f-b030-94643c28e209",
        "corporation_id": "2535af08-a139-4d0c-9827-1651e46dfbcf",
        "name": "John Doe",
        "email": "[email protected]",
        "shipping_address": {
          "postal_code": "90401",
          "state": "CA",
          "country": "US",
          "address_line_1": "1776 Main St",
          "address_line_2": "Apt. #123",
          "address_line_3": "<string>",
          "city": "Santa Monica"
        },
        "external_id": "<string>",
        "exemption_metadata": {
          "total_certificates": 123,
          "certificate_types": [
            "<string>"
          ],
          "total_exempted_states": 123,
          "expired_exemptions_count": 123,
          "inactive_exemptions_count": 123,
          "exempted_states": [
            "<string>"
          ],
          "active_exemptions_count": 123,
          "non_expired_exemptions_count": 123
        }
      }
    ],
    "total_customers": 123,
    "cursor": "<string>"
  },
  "message": "Successfully fetched customers."
}

GET

customers

List customers

curl --request GET \
  --url https://base_url/api/v1/customers \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "customers": [
      {
        "id": "b6d009b0-d174-463f-b030-94643c28e209",
        "corporation_id": "2535af08-a139-4d0c-9827-1651e46dfbcf",
        "name": "John Doe",
        "email": "[email protected]",
        "shipping_address": {
          "postal_code": "90401",
          "state": "CA",
          "country": "US",
          "address_line_1": "1776 Main St",
          "address_line_2": "Apt. #123",
          "address_line_3": "<string>",
          "city": "Santa Monica"
        },
        "external_id": "<string>",
        "exemption_metadata": {
          "total_certificates": 123,
          "certificate_types": [
            "<string>"
          ],
          "total_exempted_states": 123,
          "expired_exemptions_count": 123,
          "inactive_exemptions_count": 123,
          "exempted_states": [
            "<string>"
          ],
          "active_exemptions_count": 123,
          "non_expired_exemptions_count": 123
        }
      }
    ],
    "total_customers": 123,
    "cursor": "<string>"
  },
  "message": "Successfully fetched customers."
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

corporation_id

string

required

The unique identifier for a corporation used to filter the relevant customer base.

cursor

string

Cursor for pagination

limit

integer

default:10

Number of items to return per page

Required range: 1 <= x <= 100

Response

List of customers associated with the requesting corporation

data

object

Show child attributes

data.customers

object[]

Show child attributes

data.customers.id

string

The unique identifier for this customer.

Example:

"b6d009b0-d174-463f-b030-94643c28e209"

data.customers.corporation_id

string

The unique identifier for the corporation associated with this customer.

Example:

"2535af08-a139-4d0c-9827-1651e46dfbcf"

data.customers.name

string

A display name for this customer.

Example:

"John Doe"

data.customers.email

string<email>

Email address of the customer.

data.customers.shipping_address

object

Show child attributes

data.customers.shipping_address.postal_code

string

required

Either 5-digit ZIP code or 9-digit ZIP+4 code is accepted.

Example:

"90401"

data.customers.shipping_address.state

string

required

2-letter code for each state. Suffix of the ISO 3166-2 code. Ex: CA, NY, TX.

Example:

"CA"

data.customers.shipping_address.country

string

required

ISO 3166 2-letter country code. Ex: US, IN, GB.

Example:

"US"

data.customers.shipping_address.address_line_1

string

Example:

"1776 Main St"

data.customers.shipping_address.address_line_2

string

Example:

"Apt. #123"

data.customers.shipping_address.address_line_3

string

data.customers.shipping_address.city

string

Example:

"Santa Monica"

data.customers.external_id

string

External identifier for the customer.

data.customers.exemption_metadata

object

Show child attributes

data.customers.exemption_metadata.total_certificates

integer

Total number of exemption certificates for this customer

data.customers.exemption_metadata.certificate_types

string[]

List of unique certificate types held by this customer

data.customers.exemption_metadata.total_exempted_states

integer

Total number of states where the customer has exemptions

data.customers.exemption_metadata.expired_exemptions_count

integer

Number of expired exemption certificates

data.customers.exemption_metadata.inactive_exemptions_count

integer

Number of inactive exemption certificates

data.customers.exemption_metadata.exempted_states

string[]

List of states where the customer has exemptions

data.customers.exemption_metadata.active_exemptions_count

integer

Number of active exemption certificates

data.customers.exemption_metadata.non_expired_exemptions_count

integer

Number of non-expired exemption certificates

data.total_customers

integer

Total number of customers associated with the corporation.

data.cursor

string

Pagination cursor for the next set of results.

message

string

Example:

"Successfully fetched customers."

Create customer Get customer

⌘I

Sales Tax API

Core Concepts

Corporations

Calculate

Transactions

Nexus

Registrations

Filings

Products

Customers

Exemption Certificates

Files

Webhooks

List customers

Authorizations

Query Parameters

Response