To provide a cleaner structure, more data, better search options, and improved performance, we have introduced a new set of Channels APIs to access your channels through our public APIs.
New endpoints will be available, with the old endpoints remaining until June 30, 2026. We recommend migrating to the new endpoints prior to that date for the smoothest transition.
In this article:
Summary of changes
See the table below for the affected endpoints and their proposed new endpoints:
| Endpoint name | Old endpoint | New endpoint |
|---|---|---|
| Get Team Channels | https://api.falcon.io/teams/team_id/channels | https://api.falcon.io/channels/v2/channels |
| Get Channels | https://api.falcon.io/channels | https://api.falcon.io/channels/v2/channels |
| Get Channel | https://api.falcon.io/channels/channel_id | https://api.falcon.io/channels/v2/channels |
| Get Channel Groups | https://api.falcon.io/publish/publishing/sourcegroup | https://api.falcon.io/channels/v2/groups |
The following changes have taken place for channel data:
- The primary ID is now the previous UUID field, which is always in a dashed format.
- The previous id field is available as legacyID in the new response.
- Generally, the endpoints accept the UUID in both dashed and undashed format, but they will always return the dashed format.
The source_type is now called network_type, and a couple network names have changed:
- linkedIn > linkedin (lowercase i)
- twitterprofile > twitter
New API descriptions
Get Channels endpoint
The Get Channels endpoint is our general go-to channels search endpoint.
Please see the linked API document for all the search options provided. For best performance, please restrict the requestedFields response filter to the ones you need.
Get Channel endpoint
The Get Channel endpoint can be used to get data for a single channel.
The endpoint supports UUID as a path variable (both dashed and undashed forms).
Get ChannelGroups endpoint
The Get ChannelGroups endpoint can be used to query all ChannelGroups for your organization, optionally searching based on the name.
Get ChannelGroup endpoint
The Get ChannelGroup endpoint can get a single ChannelGroup for your organization, based on Group ID.
Migration examples
Get Team Channels
Request body:
{
“teamIds”: [“teamId”],
“responseFields: [“id”, “name”]
} Get All Channels
Request body:
{
“responseFields”: [“id”, “legacyId”, “name”, “networkType”]
} Get Singular Channel
- Previous call
- New call: uuid-based or legacyId-based
Request body for legacyId-based search:
{
“channelIds”: [“channelId”],
“responseFields”: [“id”, “legacyId”, “name”, “networkType”]
}