Getting started
A valid request URL is required to generate request examples{
"items": [
{
"customerId": "<string>",
"customerType": "CONSUMER",
"name": "<string>",
"contact": {
"email": "[email protected]",
"msisdn": "<string>"
},
"identity": "<string>",
"preferredLocale": "en-US",
"humanReadableId": "29A-BY3Z-X78",
"billing": {
"method": "E_INVOICE",
"currency": "USD",
"email": "[email protected]",
"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"
}
],
"contactPersonUserId": "<string>",
"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"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"metadata": {}
}
],
"pagination": {
"total": 123,
"limit": 123,
"offset": 123,
"sort": {
"key": "<string>",
"direction": "ASC"
}
}
}List customers
List all customers.
Will return all customers the requester has access to.
A valid request URL is required to generate request examples{
"items": [
{
"customerId": "<string>",
"customerType": "CONSUMER",
"name": "<string>",
"contact": {
"email": "[email protected]",
"msisdn": "<string>"
},
"identity": "<string>",
"preferredLocale": "en-US",
"humanReadableId": "29A-BY3Z-X78",
"billing": {
"method": "E_INVOICE",
"currency": "USD",
"email": "[email protected]",
"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"
}
],
"contactPersonUserId": "<string>",
"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"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"metadata": {}
}
],
"pagination": {
"total": 123,
"limit": 123,
"offset": 123,
"sort": {
"key": "<string>",
"direction": "ASC"
}
}
}Authorizations
An API key that grants access to the Connect API. You can create and manage API keys in the portal.
Query Parameters
A free text search string to filter customers.
The maximum number of items to return.
1 <= x <= 1000The number of items to skip before starting to collect the result set.
x >= 0Response
A list of customers.
Show child attributes
Show child attributes
Unique identifier for the customer.
The type of customer.
CONSUMER, BUSINESS Name of the customer.
The identity of the entity, such as personal number, organization number, etc., depending on the country, entity, and customer type.
The preferred locale for the customer, in IETF BCP 47 format (e.g., "en-US", "sv-SE").
"en-US"
A human-readable identifier for the customer that customers can state in support requests.
"29A-BY3Z-X78"
Billing configuration and payment preferences for the customer.
Show child attributes
Show child attributes
How invoices should be delivered to the customer.
E_INVOICE, EMAIL_INVOICE, PAPER_INVOICE The currency for customer billing and payments.
"USD"
The email address to send invoices to. Required if billing method is EMAIL_INVOICE.
The billing address for the customer. Required if billing method is PAPER_INVOICE.
Show child attributes
Show child attributes
The first line of the address, typically street and house number.
"500 S Main St"
The city or municipality of the address.
"Natick"
The zip code of the address.
Depending on the country, this may be referred to as a postal code or postcode.
Specifically for US addresses, the zip can include the optional four-digit extension (e.g., '27604-5121').
"01701"
The two-letter country abbreviation (e.g., 'US' for United States, 'SE' for Sweden).
"US"
The second line of the address, typically apartment, suite, unit, building, floor, etc.
"Apt 1"
For countries that use states or regions, the state or administrative area code (e.g., 'CA' for California in the United States).
"CA"
A province, region, or territory name, applicable in certain countries (e.g., 'Ontario' in Canada, 'Sindh' in Pakistan).
An optional line for specifying a person, department, or attention to a specific entity within an address.
Default payment profile to use for automatic payments and new orders. If specified, enables automatic payment collection for invoices and bills.
"c1d2e3f4-a5b6-7890-1234-901234567890"
Whether to automatically charge the default payment profile for invoices and bills. Requires defaultPaymentProfileId to be set.
true
The unique identifier for the contact person user.
The primary contact person for the customer.
The shipping address for the customer.
This address is used for shipping physical goods to the customer, such as SIM cards or devices. It is also used to pre-fill the address when ordering physical goods.
Show child attributes
Show child attributes
Name of the shipping recipient.
"John Doe"
Show child attributes
Show child attributes
The first line of the address, typically street and house number.
"500 S Main St"
The city or municipality of the address.
"Natick"
The zip code of the address.
Depending on the country, this may be referred to as a postal code or postcode.
Specifically for US addresses, the zip can include the optional four-digit extension (e.g., '27604-5121').
"01701"
The two-letter country abbreviation (e.g., 'US' for United States, 'SE' for Sweden).
"US"
The second line of the address, typically apartment, suite, unit, building, floor, etc.
"Apt 1"
For countries that use states or regions, the state or administrative area code (e.g., 'CA' for California in the United States).
"CA"
A province, region, or territory name, applicable in certain countries (e.g., 'Ontario' in Canada, 'Sindh' in Pakistan).
An optional line for specifying a person, department, or attention to a specific entity within an address.
Phone number for delivery contact.
"+15551234567"
Special delivery instructions.
"Leave at front door"
Date and time when the customer was created.
Date and time when the customer was last updated.
Show child attributes
Show child attributes
The total number of items available.
The maximum number of items to return.
The number of items to skip before starting to collect the items.