List customers - Commenda — Entity Management, Indirect Tax, Compliance & Corporate APIs for Multinationals

GET /customers?corporation_id=corp_123&limit=20&extend=shipping_address&search_term=acme

{
  "customers": [
    {
      "id": "cust_789",
      "name": "Acme Corporation",
      "email": "contact@acme.com",
      "corporation_id": "corp_123",
      "created_at": 1706000000,
      "shipping_address": {
        "line1": "123 Main St",
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94105",
        "country": "US"
      }
    }
  ],
  "total_customers": 1,
  "cursor": null
}

GET

customers

GET /customers?corporation_id=corp_123&limit=20&extend=shipping_address&search_term=acme

{
  "customers": [
    {
      "id": "cust_789",
      "name": "Acme Corporation",
      "email": "contact@acme.com",
      "corporation_id": "corp_123",
      "created_at": 1706000000,
      "shipping_address": {
        "line1": "123 Main St",
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94105",
        "country": "US"
      }
    }
  ],
  "total_customers": 1,
  "cursor": null
}

Retrieves a paginated list of customers for a corporation with optional filtering and search capabilities.

Query parameters

corporation_id

string

required

The unique identifier for the corporation

cursor

string

Pagination cursor for fetching the next page of results

limit

int32

default:"10"

Maximum number of customers to return (max: 100)

name

string

Filter customers by exact name match

search_term

string

Search customers by name (partial match)

source_platforms

string

Comma-separated list of source platforms to filter by

source_platform_ids

string

Comma-separated list of source platform IDs to filter by

extend

string

Comma-separated list of fields to include in response. Options: shipping_address, exemption_metadata

Exemption filters

certificate_types

string

Comma-separated list of certificate types to filter by

exemption_jurisdiction

string

Filter by exemption jurisdiction

expiration_status

string

Filter by certificate expiration status

exemption_status

string

Filter by exemption status

has_exemption

boolean

Filter customers by whether they have exemptions

Response

customers

array

Array of customer objects

Show customer properties

string

Unique identifier for the customer

name

string

Customer name

string

Customer email address

corporation_id

string

The corporation ID this customer belongs to

created_at

int64

Unix timestamp of when the customer was created

source_platform_id

string

Source platform identifier (if applicable)

source_platform

string

Source platform name (if applicable)

business_identification_number

string

The customer’s tax or business registration number, if provided

shipping_address

object

Customer’s shipping address (included when extend=shipping_address)

Show shipping_address properties

line1

string

Street address line 1

line2

string

Street address line 2

city

string

City name

state

string

State or province code

postal_code

string

Postal or ZIP code

country

string

ISO 3166 2-letter country code

exemption_metadata

object

Exemption information (included when extend=exemption_metadata)

total_customers

int64

Total number of customers matching the query

cursor

string

Pagination cursor for the next page (if more results exist)

GET /customers?corporation_id=corp_123&limit=20&extend=shipping_address&search_term=acme

{
  "customers": [
    {
      "id": "cust_789",
      "name": "Acme Corporation",
      "email": "contact@acme.com",
      "corporation_id": "corp_123",
      "created_at": 1706000000,
      "shipping_address": {
        "line1": "123 Main St",
        "city": "San Francisco",
        "state": "CA",
        "postal_code": "94105",
        "country": "US"
      }
    }
  ],
  "total_customers": 1,
  "cursor": null
}

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

message

string

Example:

"Successfully fetched customers."

Create customer Get customer

​Query parameters

​Exemption filters

​Response

Authorizations

Query Parameters

Response

Query parameters

Exemption filters

Response