Get a list of active customers
URL
GET https://contoso-prod-api.azurewebsites.net/api/activecustomers/v5
Request headers
Key | Value |
Authorization | Bearer <access_token> |
Content-Type | Application/json |
Request body
The request doesn’t require any parameters / body
Response body
An example response for the request to get active customers is as follows:
{
"OperationType": null,
"Status": "Success",
"RequestCorrelationID": "f9e9876b-6a50-4c24-98da-0c7bee020e98",
"ErrorMessage": null,
"ErrorDetail": null,
"Data": [
{
"CustomerFirstName": "John",
"CustomerLastName": "Doe",
"Name": "Contoso",
"CustomerID": "HUBB11CD-1234-42DC-8489-75379890A3B7ED9",
"TenantId": "0f96f6b1-fe7f-8909-5678-152d0f56f171",
"CustomerBillingReferenceId": null,
"LinkedProviderName": "Microsoft",
"ProviderReferenceName": "contoso.onmicrosoft.com",
"EmailAddresses": "johndoe@contoso.com",
"PhoneNumbers": "(123)456-7890",
"Line1": "3600 86th Street",
"Line2": null,
"City": "Urbandale",
"State": "IA",
"Zip": null,
"Country": "US",
"CustomerBillingType": null,
"ERPCustomerID": null,
"CRMOpportunityID": null
}Here is the explanation for the properties in the response (JSON)
Property | Description | ||||||||||||||||||||||||||||
OperationType | Can be ignored | ||||||||||||||||||||||||||||
Status | Indicates the status of the request. Possible values – Success / Error | ||||||||||||||||||||||||||||
RequestCorrelationID | Internal ID generated by C3 for correspondence for troubleshooting issues, if any. | ||||||||||||||||||||||||||||
ErrorMessage | Message in case the request runs into an error during processing | ||||||||||||||||||||||||||||
ErrorDetail | Additional detail related to the error in case there is an error while processing the request | ||||||||||||||||||||||||||||
Data | Contains a list of customer objects represented by the following attributes:
|