curl --request GET \
--url https://apiv2.example.com/customers \
--header 'X-Api-Key: <api-key>'{
"items": [
{
"customerId": "<string>",
"customerType": "CONSUMER",
"name": "<string>",
"contact": {
"email": "jsmith@example.com",
"msisdn": "<string>"
},
"identity": "<string>",
"preferredLocale": "en-US",
"humanReadableId": "29A-BY3Z-X78",
"referenceId": "crm-customer-12345",
"billing": {
"method": "E_INVOICE",
"currency": "USD",
"email": "billing@company.com",
"address": {
"street1": "500 S Main St",
"city": "Natick",
"zip": "01701",
"country": "US",
"street2": "Apt 1",
"state": "CA",
"region": "<string>",
"attention": "<string>"
},
"defaultPaymentProfileId": "c1d2e3f4-a5b6-7890-1234-901234567890",
"autoPay": true
},
"users": [
{
"userId": "<string>",
"name": "<string>",
"role": "MEMBER"
}
],
"contactPerson": {
"userId": "<string>",
"name": "<string>",
"role": "MEMBER"
},
"shipping": {
"name": "John Doe",
"address": {
"street1": "500 S Main St",
"city": "Natick",
"zip": "01701",
"country": "US",
"street2": "Apt 1",
"state": "CA",
"region": "<string>",
"attention": "<string>"
},
"msisdn": "+15551234567",
"instructions": "Leave at front door"
},
"metadata": {}
}
],
"pagination": {
"nextCursor": "<string>"
}
}List all customers.
Will return all customers the requester has access to.
curl --request GET \
--url https://apiv2.example.com/customers \
--header 'X-Api-Key: <api-key>'{
"items": [
{
"customerId": "<string>",
"customerType": "CONSUMER",
"name": "<string>",
"contact": {
"email": "jsmith@example.com",
"msisdn": "<string>"
},
"identity": "<string>",
"preferredLocale": "en-US",
"humanReadableId": "29A-BY3Z-X78",
"referenceId": "crm-customer-12345",
"billing": {
"method": "E_INVOICE",
"currency": "USD",
"email": "billing@company.com",
"address": {
"street1": "500 S Main St",
"city": "Natick",
"zip": "01701",
"country": "US",
"street2": "Apt 1",
"state": "CA",
"region": "<string>",
"attention": "<string>"
},
"defaultPaymentProfileId": "c1d2e3f4-a5b6-7890-1234-901234567890",
"autoPay": true
},
"users": [
{
"userId": "<string>",
"name": "<string>",
"role": "MEMBER"
}
],
"contactPerson": {
"userId": "<string>",
"name": "<string>",
"role": "MEMBER"
},
"shipping": {
"name": "John Doe",
"address": {
"street1": "500 S Main St",
"city": "Natick",
"zip": "01701",
"country": "US",
"street2": "Apt 1",
"state": "CA",
"region": "<string>",
"attention": "<string>"
},
"msisdn": "+15551234567",
"instructions": "Leave at front door"
},
"metadata": {}
}
],
"pagination": {
"nextCursor": "<string>"
}
}An API key that grants access to the Connect API. You can create and manage API keys in the portal.
A free text search string to filter customers.
The maximum number of items to return.
1 <= x <= 1000Opaque pagination token from a previous response's nextCursor.