Get Active Customers and Resellers

Prev Next

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

ParameterRequiredDescription
{{apiUrl}}YesC3 Portal API URL.

Request Headers

HeaderValue
AuthorizationBearer <access_token>
Content-Typeapplication/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

PropertyDescription
OperationTypeReserved for internal use. Can be ignored.
StatusIndicates the result of the request. Possible values: Success, Error.
RequestCorrelationIDUnique identifier generated by C3 for request tracking and troubleshooting.
ErrorMessageContains the error message if request processing fails.
ErrorDetailContains additional error information.
DataCollection of active customer records.

Customer Attributes

AttributeDescription
CustomerFirstNameContact person's first name.
CustomerLastNameContact person's last name.
NameName of the customer's organization.
CustomerIDUnique identifier assigned to the customer within C3.
TenantIdCustomer's Microsoft Entra ID tenant identifier.
CustomerBillingReferenceIdCustom billing reference configured for the customer through Customer Configuration.
LinkedProviderNameAssociated provider, such as Microsoft or a partner provider.
ProviderReferenceNameDomain name associated with the customer tenant.
EmailAddressesContact person's email address.
PhoneNumbersContact person's phone number.
Line1Primary address line.
Line2Secondary address line.
CityCity associated with the customer address.
StateState or province associated with the customer address.
ZipPostal or ZIP code associated with the customer address.
CountryCountry or region associated with the customer address.
CustomerBillingTypeCustom billing type configured for the customer through Customer Configuration.
ERPCustomerIDERP Customer ID configured for the customer through Customer Configuration.
CRMOpportunityIDCRM Opportunity ID configured for the customer through Customer Configuration.
Note

CustomerBillingReferenceId, CustomerBillingType, ERPCustomerID, and CRMOpportunityID are optional attributes that are populated only when configured for the customer.