GET
/
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": "jsmith@example.com",
        "shipping_address": {
          "address_line_1": "1776 Main St",
          "address_line_2": "Apt. #123",
          "address_line_3": "<string>",
          "postal_code": "90401",
          "city": "Santa Monica",
          "state": "CA",
          "country": "US"
        },
        "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

200
application/json

List of customers associated with the requesting corporation

The response is of type object.