List User Sales Channels
๐งพ List User Sales Channels
Endpoint: GET /api/v3/user-sales-channels
Auth Required: โ Yes (Bearer Token)
๐ Description
Returns the list of sales channels that are accessible to the currently authenticated user. Sales channels may be used for filtering visit requests, organizing reporting, or enforcing user access control based on business units or territories.
๐ Query Parameters
Parameter | Type | Required | Default | Description |
---|---|---|---|---|
includeInactive |
boolean | No | โ | If true, includes inactive sales channels. |
languageId |
integer | No | โ | Language ID for localized names. |
๐ค Request Example
GET https://api.briefingedge.com/api/v3/user-sales-channels?includeInactive=false&languageId=1 Authorization: Bearer <token>
โ Success Response (200 OK)
Returns an array of UserSalesChannel
objects.
Example:
[ { "SalesChannelID": 1, "Name": "Enterprise North America", "IsActive": true }, { "SalesChannelID": 2, "Name": "APAC Commercial", "IsActive": true } ]
โ Error Responses
Code | Message | Description |
---|---|---|
401 | Unauthorized | Missing or invalid bearer token. |
500 | Internal Server Error | Unexpected server-side failure. |