The Channel API allows your third-party software to directly access information relating to each of your channels in Social Media Management. With the Channel API, you can view your existing channels and channel groups.
In this article, find out more about the information available in the Channel API and how you can use the data.
Note:
This article offers an introduction to the Social Media Management Channel API. For developer information, please visit Social Media Management's API Technical Documentation. Visit our article on Getting Access to Social Media Management APIs for first-time steps.
In this article:
Channel API endpoints
There are four endpoints available via the Channel API:
- Get Channels
- Get Instagram Channels
- Get Channel
- Get Channel Groups
- Get Channels
-
Using the get channels endpoint, you can receive all available information for all channels associated with your Social Media Management organization, whether connected or disconnected. Results will include each channel’s ID, UUID, associated network, name, connected status, and more.
You can limit your results to a total number of channels and also sort your results by name (ascending or descending).
- Get Instagram Channels
-
Using the get Instagram Channels endpoint, you can receive information relating to any Instagram channels which are currently connected to your Social Media Management organization. Your results will include the channel’s name, ID, UUID, profile image, username, fans, and more.
- Get Channel
-
The Get Channel endpoint will return all information listed above for the Get Channels endpoint, though only for only one specified channel. You can specify the channel using the Channel ID.
For help obtaining your channel’s ID, please follow the guide below.
- Get Channel Groups
-
If you have created any channel groups in Social Media Management, you can use the Get Channel Groups endpoint to receive the information about all channel groups in your Social Media Management organization.
Your results will include the channel group ID, creation date, title, included channels, and more.
Finding a Channel ID
For the above endpoint, Get Channel, you will first need to obtain your channel ID. There are two possible ways to find the ID for your channel:
Via the Channel API
Using the above endpoint, Get Channels, your results will contain the information related to all channels associated with your Social Media Management organization, including each channel’s Channel ID.
Via Social Media Management
In Social Media Management, any user with a user role of Team Leader or Admin can find the ID for your channel by navigating to Channel Admin and selecting the channel.
The Channel ID will appear beside the channel name at the top of the page as shown below.
Benefits of the Channel API
Using the Channel API, you could include the list of your organization's Channels along with their connected status or current Channel Group setup in a custom report, external Dashboard, or big screen. Doing so could help to alert users of Channels in need of reconnection and provide awareness of filtering options in Publish.
In addition, the Channel API enables you to locate your Channel IDs which you will need for creating Engage exports via the Engage API or configuring your Channel's content via the Content API.
Accessing technical documentation
For general information about the features of our available APIs, check out our Introduction to APIs section. To view technical documentation for each Social Media Management API, please visit: falconio.docs.apiary.io.