Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt

Use this method to get a list of Customers associated with a Company.

Tip

Valid tokens: User.



Filter by label (Content by label)
showLabelsfalse
max5
titleRelated Articles
cqllabel in ( "api" , "customers" )

Request


URL: https://api.kometsales.com/api/customer.by.company.list

Method: GET

Content-Type: URL Parameters


Header

X-SALES-CHANNEL (required)(string:20)

Sales Channel.

Valid values: "WEB_APP", "MOBILE_APP", "K2K" , "ECOMMERCE_LITE". 


X-ACCOUNT (required)(integer:20)

Company ID that is using the API.

Please ask the Komet Sales team for this ID. 


Input parameters

authenticationToken (required)(string:50)

Komet Sales security token.


showSalespersonCustomers (optional)(Boolean)

Only display Customers associated to the User making the request.

Valid values: True = Yes | False = Show every Customer


Code Block
languagejs
https://api.kometsales.com/api/customer.by.company.list?
authenticationToken=token_info_goes_here

Response


customerResult (array) 

An array containing the Customer information.


customerId (integer 10)

The Customer ID.


customerName (String)

The Customer’s day.


Code Block
{
    "customerResult": [
        {
            "customerId": 29675,
            "customerName": "10 DOWNING ST"
        },
        {
            "customerId": 7359,
            "customerName": "2-14 ENTERPRISES BRIDAL CAKES"
        },
        {
            "customerId": 29623,
            "customerName": "A NEW LEAF OF WI,LLC"
        },
        {
            "customerId": 29671,
            "customerName": "a TRIO JEWELRY & DESIGN LLC"
        }
        ]
}

We've encountered an issue exporting this macro. Please try exporting this page again later.