Scope: sales:sales-channels.read https://api.alladdin.com/api/v2/sales-channels

Returns the list of all sales channels in your account.
The response includes both active and archived sales channels. Use sales channel IDs when setting defaults on contacts or assigning revenue to document lines.

Request

import requests

url = "https://api.alladdin.com/api/v2/sales-channels"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

response = requests.get(url, headers=headers)
print(response.json())

Responses

Response

{
  "items": [
    {
      "id": "507f1f77bcf86cd799439011",
      "name": "Office Expenses",
      "color": "#FF5733",
      "account_num": 6290001,
      "archived": false,
      "description": "string"
    }
  ]
}

Success responses

200 List of sales channels application/json object items[] object[] id string

Unique identifier of the accounting account

name string

Display name of the accounting account

color string

Hex color code used in the UI

account_num integer

Numeric accounting code from the chart of accounts

archived boolean

Whether the account is archived

description string | null

Description of the accounting account

Error responses

401 Invalid or missing API key application/json 403 Insufficient permissions application/json

← PreviousUpdate a sales channel →

Next →Get a sales channel by ID →