Retrieves active customer records with detailed profile information, contact details, address information, provider references, billing references, ERP references, and CRM references. This version extends the information returned by v3 by including additional billing and external system reference fields.
Endpoint
GET {{apiUrl}}/api/ActiveCustomers/v5
Endpoint Parameters
| Parameter | Required | Description |
|---|---|---|
{{apiUrl}} | Yes | C3 Portal API URL. |
Request Headers
| Header | Value |
|---|---|
| Authorization | Bearer <access_token> |
| Content-Type | application/json |
Request Body
No request body is required for this endpoint.
Successful Response
A successful request returns a list of active customers along with customer profile, contact information, tenant details, provider information, and customer configuration attributes.
Sample Response
{
"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
}
]
}Response Properties
| Property | Description |
|---|---|
| OperationType | Reserved for internal use. Can be ignored. |
| Status | Indicates the result of the request. Possible values: Success, Error. |
| RequestCorrelationID | Unique identifier generated by C3 for request tracking and troubleshooting. |
| ErrorMessage | Contains the error message if request processing fails. |
| ErrorDetail | Contains additional error information. |
| Data | Collection of active customer records. |
Customer Attributes
| Attribute | Description |
|---|---|
| CustomerFirstName | Contact person's first name. |
| CustomerLastName | Contact person's last name. |
| Name | Name of the customer's organization. |
| CustomerID | Unique identifier assigned to the customer within C3. |
| TenantId | Customer's Microsoft Entra ID tenant identifier. |
| CustomerBillingReferenceId | Custom billing reference configured for the customer through Customer Configuration. |
| LinkedProviderName | Associated provider, such as Microsoft or a partner provider. |
| ProviderReferenceName | Domain name associated with the customer tenant. |
| EmailAddresses | Contact person's email address. |
| PhoneNumbers | Contact person's phone number. |
| Line1 | Primary address line. |
| Line2 | Secondary address line. |
| City | City associated with the customer address. |
| State | State or province associated with the customer address. |
| Zip | Postal or ZIP code associated with the customer address. |
| Country | Country or region associated with the customer address. |
| CustomerBillingType | Custom billing type configured for the customer through Customer Configuration. |
| ERPCustomerID | ERP Customer ID configured for the customer through Customer Configuration. |
| CRMOpportunityID | CRM Opportunity ID configured for the customer through Customer Configuration. |
CustomerBillingReferenceId, CustomerBillingType, ERPCustomerID, and CRMOpportunityID are optional attributes that are populated only when configured for the customer.