API reference
- Getting Started with Your API
- SDKs and Toolkits
- Customer Overview
- GETGet Account Attributes
- POSTAdd Account Attribute
- GETGet Account Attribute
- PUTUpdate Account Attribute
- DELDelete Account Attribute
- GETGet Account Cards
- POSTAdd Account Card
- GETGet Account Card
- PUTUpdate Account Card
- DELDelete Account Card
- GETGet Account Contacts
- PUTAdd Account Contact List
- POSTAdd Account Contact
- GETGet Account Contact
- PUTUpdate Account Contact
- DELDelete Account Contact
- GETGet Accounts
- POSTAdd Account
- GETGet Account
- PUTUpdate Account
- DELDelete Account
- GETRetrieve Current Account
- GETGet Transactions
- POSTAdd Transaction
- DELRemove Transaction
- POSTRecompute Customer Lifetime Value
- GETGet Account Notes
- POSTAdd Account Note
- GETGet Account Note
- PUTUpdate Account Note
- DELDelete Account Note
- GETGet Account Segments
- GETGet Account Audit Log
- GETGet Customer Purchase Order Account
- PUTUpdate Customer Purchase Order Account
- POSTCreate Customer Purchase Order Account
- GETGet Customer Purchase Order Transactions
- POSTCreate Purchase Order Transaction
- POSTGet Customers Purchase Order Accounts
- POSTGet Login State By UserName
- POSTGet Login State By Email Address
- GETGet Login State
- POSTChange Password
- POSTChange Passwords
- POSTReset Password
- POSTUpdate Forgotten Password
- POSTAdd Login To Existing Customer
- POSTAdd Account And Login
- POSTSet Login Locked
- POSTSet Password Change Required
- POSTAdd Accounts
- GET
A valid request URL is required to generate request examples{
"startIndex": 123,
"pageSize": 123,
"pageCount": 123,
"totalCount": 123,
"items": [
{
"accountId": 123,
"types": [
{
"name": "<string>",
"isPrimary": true
}
],
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
},
"faxNumber": "<string>",
"label": "<string>",
"id": 123,
"email": "<string>",
"firstName": "<string>",
"middleNameOrInitial": "<string>",
"lastNameOrSurname": "<string>",
"companyOrOrganization": "<string>",
"phoneNumbers": {
"home": "<string>",
"mobile": "<string>",
"work": "<string>"
},
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"cityOrTown": "<string>",
"stateOrProvince": "<string>",
"postalOrZipCode": "<string>",
"countryCode": "<string>",
"addressType": "<string>",
"isValidated": true
}
}
]
}Get Account Contacts
Retrieves a list of contacts for a customer according to any specified filter criteria and sort options.
A valid request URL is required to generate request examples{
"startIndex": 123,
"pageSize": 123,
"pageCount": 123,
"totalCount": 123,
"items": [
{
"accountId": 123,
"types": [
{
"name": "<string>",
"isPrimary": true
}
],
"auditInfo": {
"updateDate": "2023-11-07T05:31:56Z",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"createBy": "<string>"
},
"faxNumber": "<string>",
"label": "<string>",
"id": 123,
"email": "<string>",
"firstName": "<string>",
"middleNameOrInitial": "<string>",
"lastNameOrSurname": "<string>",
"companyOrOrganization": "<string>",
"phoneNumbers": {
"home": "<string>",
"mobile": "<string>",
"work": "<string>"
},
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"cityOrTown": "<string>",
"stateOrProvince": "<string>",
"postalOrZipCode": "<string>",
"countryCode": "<string>",
"addressType": "<string>",
"isValidated": true
}
}
]
}Authorizations
JWT Authorization header using the Bearer scheme.
Path Parameters
Unique identifier of the customer account whose CustomerContact information you want to retrieve.
Query Parameters
Used to page results from a query. Indicates the zero-based offset in the complete result set where the returned entities begin. For example, with a PageSize of 25, to get the 51st through the 75th items, startIndex=3. The default value is 0. Optional.
Used to page results from a query. Indicates the maximum number of entities to return from a query. The default value is 20 and the maximum value is 200. Optional.
The element to sort the results by and the order in which the results appear. Either ascending (a-z) or descending (z-a) order. Optional.
A set of filter expressions representing the search parameters for a query: eq=equals, ne=not equals, gt=greater than, lt = less than or equals, gt = greater than or equals, lt = less than or equals, sw = starts with, or cont = contains. Optional.
If provided, the primary markings on the contacts will be based on the user's preferred primary overrides
limits which fields are returned in the response body