Overview

This method returns a list of companies associated to the logged on user. Keep in mind that this method only works with user's tokens. 

Request

https://api.kometsales.com/api/company.list

  • Method: GET
  • Content-Type: URL Params.

Header

  • X-SALES-CHANNEL (string: 20): Valid values: "WEB_APP", "MOBILE_APP", "K2K" , "ECOMMERCE_LITE". 

 

Input parameters:

  • authenticationToken (required) (string:50): Komet Sales security token.

 

Sample
https://api.kometsales.com/api/company.list?authenticationToken=token_info_goes_here

Response

Output:

  • companyResult : array of companies associated
    • companyId (integer 10): The ID of the company.
    • companyName (String): The name of the company.
    • roleId (integer 10): the code of the role the user has within the company. Ej: 27: e-commerce user.
    • customerId (integer 10): customer Id. You can obtain this value from the  customer.list API method.
    • name (string 200): the name of the customer.


Sample
{
 "companyResult": 
       [ 
          { "companyId": 6316,
            "companyName": "Demo Account", 
            "roleId": 1, 
            "customerId": null, 
            "customerName": null } 
       ] 
}