| Excerpt | ||
|---|---|---|
Use this method to get a list of companies associated with the logged User.
|
| Filter by label (Content by label) | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Request
URL: https://api.kometsales.com/api/company.list
Method: GET
Content-Type: URL Parameters
Header
X-SALES-CHANNEL (string: 20)
The sales channel.
Valid values: "WEB_APP", "MOBILE_APP", "K2K" , "ECOMMERCE_LITE".
Input parameters
authenticationToken (required) (string:50)
Komet Sales security token.
| Code Block | ||
|---|---|---|
| ||
https://api.kometsales.com/api/company.list? authenticationToken=token_info_goes_here |
Response
companyResult (array)
An array of associated companies.
companyId (integer:10)
The Company ID.
companyName (String)
The Company name.
roleId (integer:10)
The User Role code within the company.
Example: 27: e-commerce user.
customerId (integer 10)
The Customer ID.
You can get this value from the customer.list API method.
name (string 200)
The Customer name.
| Code Block |
|---|
{
"companyResult":
[
{ "companyId": 6316,
"companyName": "Demo Account",
"roleId": 1,
"customerId": null,
"customerName": null }
]
} |