The Axero REST API provides access to Communifire data and features. Using the REST API, you can expand functionality, customize your experience, and integrate your site with other platforms—the possibilities are endless.
First, to start using the REST API, ensure the admin has enabled REST API access in Communifire. Once the REST API is enabled, you need to get your REST API access key.
Axero does not have formal thresholds or limitations on our REST API. However, some general guidelines should be followed to prevent a negative impact on your site and its performance.
Please talk to the Axero Client Success team if you have questions about structuring your API usage for optimal performance. We reserve the right to update guidance based on observations of API usage. Additionally, if we identify API usage that is impacting your site performance, we may temporarily impose limits to maintain optimal site performance for all users.
The Users REST API includes methods to get user data, create and manage users, and create and manage user roles. You can also search for users, manage user membership, update user points, and more.
Example: If you want to use data from an existing platform or database in your community, the Users REST API is exactly what you need. Mass import user data and create new Communifire users using Add User. Use Update Address when employees move to new locales. Use Update Role as employees change titles.
REST API: Users
The Content REST API includes methods to get content and content lists, create content, and manage content. You can also get queued workflow content, manage content categories, manage files, and more.
Example: Use the Content REST API to display content on your company lobby's TV screens. You can also display photos with Get Content List, upcoming events with Get Events, and client feedback with Get Space Wall Posts.
REST API: Content
The Space REST API includes methods to get spaces and space data, create spaces, and manage spaces. You can also manage space membership, manage space roles, and more.
Example: Need to create a company organizational chart? Get department names with Get Space, employees' titles with Get User's Space Roles, and employee title descriptions with Get Space Role.
REST API: Spaces
The Chat REST API includes methods to send messages, get messages, update chat threads, and more.
Example: Want to move a conversation from email to chat? Start a new Communifire chat thread and include all participants.
REST API: Chat
The Comments REST API includes methods to create comments, get individual comments, and get comment lists. You can also edit comments, delete comments, and set comment statuses.
Example: Want to submit an idea to management? Use Get Comment List to compile others' thoughts on it.
REST API: Comments
The Permissions REST API includes methods to check a user's permissions and update a specific role's permissions.
Example: Want to share a style guideline with content creators? Use Check Permissions to check which roles have permission to create articles.
REST API: Permissions
The Recognition REST API includes a method to get recognition programs, badges, challenges, and leaderboard users; get insights for a specific user; and recognize a user.
Example: Award someone a kudos badge when they complete a task on an external platform.
REST API: Recognition
The Analytics REST API includes methods to get content, user, and space activity analytics.
Example: Display trending topics on your homepage using Get Most Liked Content. Discover who your power users are and celebrate them with Get Most Active Users.
REST API: Analytics
is requesting access to a wiki that you have locked: https://my.axerosolutions.com/spaces/5/communifire-documentation/wiki/view/370/rest-api
Your session has expired. You are being logged out.