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
}
Customers
List customers
List customers associated with a corporation.
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
string
required
The unique identifier for the corporation
string
Pagination cursor for fetching the next page of results
int32
default:"10"
Maximum number of customers to return (max: 100)
string
Filter customers by exact name match
string
Search customers by name (partial match)
string
Comma-separated list of source platforms to filter by
string
Comma-separated list of source platform IDs to filter by
string
Comma-separated list of fields to include in response. Options:
shipping_address, exemption_metadataExemption filters
string
Comma-separated list of certificate types to filter by
string
Filter by exemption jurisdiction
string
Filter by certificate expiration status
string
Filter by exemption status
boolean
Filter customers by whether they have exemptions
Response
array
Array of customer objects
Show customer properties
Show customer properties
string
Unique identifier for the customer
string
Customer name
string
Customer email address
string
The corporation ID this customer belongs to
int64
Unix timestamp of when the customer was created
string
Source platform identifier (if applicable)
string
Source platform name (if applicable)
string
The customer’s tax or business registration number, if provided
object
object
Exemption information (included when
extend=exemption_metadata)int64
Total number of customers matching the query
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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
The unique identifier for a corporation used to filter the relevant customer base.
Cursor for pagination
Number of items to return per page
Required range:
1 <= x <= 100Was this page helpful?