The Team API allows your third-party software to access direct information relating to the existing Teams in your Social Media Management organization. Using the Team API, you can gather your list of existing teams along with information relating to each individual team, such as the users, channels, connection status, disconnection reasons, and more. In this article, find out more about the information available in the Team API and how you can use the data.
Note:
This article offers an introduction to the Social Media Management Team 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:
Team API endpoints
There are four endpoints available in the Team API:
- Get Teams
- Get Team Name
- Get Team Users
- Get Team Channels
- Get Teams
-
Using the get teams endpoint, you can obtain a complete list of teams associated with your Social Media Management organization, including the IDs and names for each team.
The Get Teams endpoint will provide you with the complete list of your existing Social Media Management Teams, including the names and Team IDs.
- Get Team Name
- By providing a Team ID, you can use the get team name endpoint to obtain the team name and associated organization for a specific team.
- Get Team Users
-
By providing a Team ID, you can use the get team users endpoint to retrieve information about all associated users in the team.
Your results will contain information such as the user ID, name, creation date, admin status, login count, and more. You can choose to include deleted users in your results and also limit your results to a certain number.
- Get Team Channels
-
By providing a Team ID, you can use the get team channels endpoint to retrieve the complete list of Channels currently associated with the team.
Your results will contain information such as the channel ID, network, name, connection status, access token, and more.
Finding a Team ID
To use the Get Team Name, Get Team Users and Get Team Channels endpoints, you will first need the Team ID. There are two ways to locate the ID:
Via the Team API
Using the Get Teams endpoint, you will receive information relating to all Teams in your Social Media Management organization, including the Team IDs for each.
Via Social Media Management
In Social Media Management, any user with a user role or either Admin or Team Leader can find a Team ID.
Click the Manage settings (cog) icon in the lower-left corner of Social Media Management, then click Organization Admin. Select Teams in the left-hand Settings sidebar, then click the desired team on the Teams page.
On the following screen, your Team ID will be included in the URL of the team page as shown below.
Benefits of the Team API
Using the Team API, you can choose to create a customized report, dashboard, presentation, or big screen display to showcase your organization's existing team structure, including the team names, users, channels, and current channel connection status.
Using the Get Team Users endpoint, you can also gain insight into the platform usage of each user in a team by comparing the creation date and login count.
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.