Get active customers & RESELLERS
    • 16 Jul 2023
    • 1 Minute to read
    • Dark
      Light
    • PDF

    Get active customers & RESELLERS

    • Dark
      Light
    • PDF

    Article Summary

    Get a list of active customers as well as Resellers

    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": "97f21d5e-c817-47d6-bce0-73f1103cd184",
    
        "ErrorMessage": null,
    
        "ErrorDetail": null,
    
        "Data": [
    
            {
    
                "CustomerFirstName": "John",
    
                "CustomerLastName": "Doe",
                "Name": "City of Urbandale",
    
                "CustomerID": "9582D9F2-1234-5678-AB56-DADED948C1C4",
    
                "TenantId": "0f96f6b1-fe7f-8909-5678-152d0f2ff171",
    
                "CustomerBillingReferenceId": "",
    
                "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:

    Attribute

    Description

    CustomerFirstName

    Contact person’s first name

    CustomerLastName

    Contact person’s last name

    Name

    name of the customer

    CustomerID

    Unique identifier for the customer in C3

    TenantId

    MS tenant id

    CustomerBillingReferenceId

    billing reference id - Custom value set by the Partner on the customer via Customer Configuration

    LinkedProviderName

    Microsoft or Partner

    ProviderReferenceName

    domain name of the tenant

    EmailAddresses

    Contact person’s email address

    PhoneNumbers

    Contact person’s contact number

    CustomerBillingType

    Custom value set by the Partner on the customer via Customer Configuration

    ERPCustomerID

    ERP Customer ID - Custom value set by the Partner on the customer via Customer Configuration

    CRMOpportunityID

    CRM Opportunity ID - Custom value set by the Partner on the customer via Customer Configuration



    Was this article helpful?