The Communifire REST API provides access to Communifire data and features. Expand functionality, customize your experience, and integrate Communifire with other platforms using the Communifire REST API. The possibilities with the Communifire REST API are endless.
To start using the REST API, first make sure that the admin has enabled REST API access in Communifire. Once the REST API is enabled, you need to get your REST API access key.
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: User Overview
REST API: Get User Activity
REST API: Update User Profile Fields
REST API: Time Zones List
REST API: Update Address
REST API: Get Address
REST API: Add User
REST API: Delete User
REST API: Delete User and Re-assign Content
REST API: Update User
REST API: Validate User
REST API: Activate User
REST API: Ban User
REST API: Feature User
REST API: Check Username Availability
REST API: Check User Email Availability
REST API: Update User Points
REST API: Add User Image
REST API: Get User's REST API Key
REST API: Get User
REST API: Get User By Username
REST API: Get User Profile Fields
REST API: Get Administrators
REST API: Get Administrators and Moderators
REST API: Get User Spaces
REST API: Search Users
REST API: Get Online Users Count
REST API: Get Upcoming Birthdays and Work Anniversaries
REST API: Get Org Chart Users
REST API: Get Mentions
REST API: Get Recognition Analytics User Statistics
REST API: Get Recognition Activity
REST API: Connections
REST API: Get Connections
REST API: Accept Connection Request
REST API: Send Connection Request
REST API: Remove Connection
REST API: Check Connection Status
REST API: Get Connection Requests
REST API: Get Connection Requests Count
REST API: Get Direct Reports
REST API: Notifications
REST API: Send Notification
REST API: Send Custom Notification
REST API: Get Notifications
REST API: Get Unread Notifications
REST API: Read Notifications
REST API: User Roles
REST API: User Roles Overview
REST API: Add Role
REST API: Delete Role
REST API: Update Role
REST API: Get Role
REST API: Get User's Roles
REST API: Get Roles
REST API: Assign User Role
REST API: Unassign Role
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: Display content on your company lobby's TV screens with the Content REST API. Display photos with Get Content List. Display upcoming events with Get Events. Display client feedback with Get Space Wall Posts.
REST API: Content
REST API: System Entity Types
REST API: Activity Action ID
REST API: Content Object Overview
REST API: Create Content
REST API: Update Content
REST API: Delete Content
REST API: Set Content Status
REST API: Get Content
REST API: Get Content List
REST API: Get Multiple Content
REST API: Update Wiki Sort Order
REST API: Add Featured Image
REST API: Add Attachment
REST API: Delete Attachment
REST API: Get Attachment
REST API: Get Attachments
REST API: Set Content Read Status
REST API: Get Content Read Status
REST API: Follow Content
REST API: Unfollow Content
REST API: Get Content Followers
REST API: Add Photos
REST API: Get Queued Workflow Content
REST API: Get Unread Contents
REST API: Get Announcements
REST API: Increase View Count
REST API: Search
REST API: Get Search Analytics
REST API: Content Category
REST API: Category Overview
REST API: Create Content Category
REST API: Update Content Category
REST API: Delete Content Category
REST API: Get Content Category
REST API: Get Content Categories
REST API: Cases
REST API: Case Overview
REST API: Create Case
REST API: Update Case
REST API: Add Attachment to Case
REST API: Update Case Status
REST API: Delete Case
REST API: Get Case
REST API: Get Cases
REST API: Get Case Priorities
REST API: Get Case Projects
REST API: Get Case Statuses
REST API: Get Case Project Categories
REST API: Get Case Project Milestones
REST API: Get Case Status Statistics
REST API: Case Comments
REST API: Case Comment Overview
REST API: Create Case Comment
REST API: Update Case Comment
REST API: Delete Case Comment
REST API: Get Case Comment
REST API: Get Case Comments
REST API: Add Case Comment Attachment
REST API: Events
REST API: Event Overview
REST API: Event Attendance Types
REST API: Event List Display Types
REST API: Create Event
REST API: Update Event
REST API: Delete Event
REST API: Get Event
REST API: Get Events
REST API: Get Events By User ID
REST API: Get Calendar Events
REST API: Invite Users to Event
REST API: Add Space Members to Event
REST API: Update RSVP
REST API: Get My RSVP
REST API: Get User RSVP
REST API: Delete User From Event
REST API: Get Event Attendees
REST API: Get Event Invitees
REST API: Get Guest Attendees
REST API: Get Guest Invitees
REST API: Get Attendance Stats
REST API: Mark As Organizer
REST API: Update Event View Count
REST API: Get Countries
REST API: Get States
REST API: Event Reminders
REST API: Event Reminder Types
REST API: Create Reminder
REST API: Delete Reminder
REST API: Get Reminders
REST API: Event Resources
REST API: Create Event Resource
REST API: Delete Event Resource
REST API: Get Event Resource
REST API: Get Event Resources
REST API: Get Event Resource Availability
REST API: Get Event Resource Types
REST API: Event Types
REST API: Event Type Overview
REST API: Create Event Type
REST API: Update Event Type
REST API: Delete Event Type
REST API: Get Event Type
REST API: Get Event Types
REST API: Files
REST API: File Directory Overview
REST API: Create File Directory
REST API: Update File Directory
REST API: Delete File Directory
REST API: Get File Directory
REST API: Check File Directory Name Availability
REST API: Get Child Directories
REST API: Get Parent Directories
REST API: Get Space Directories
REST API: Get Space Root Directory
REST API: Add File
REST API: Check In File
REST API: Check Out File
REST API: Undo Check Out File
REST API: Delete File
REST API: Delete Multiple Files
REST API: Restore File
REST API: Move File
REST API: Get Files
REST API: Get Directory Files
REST API: Get Recycled Files
REST API: Get Space Files
REST API: Check File Name Availability
REST API: Forums
REST API: Forum Overview
REST API: Create Forum
REST API: Update Forum
REST API: Delete Forum
REST API: Get Forum
REST API: Get Forums
REST API: Set Forum Status
REST API: Check Forum Stub Availability
REST API: Change User Forum Subscription
REST API: Check User Forum Subscription
REST API: Forum Groups
REST API: Create Group
REST API: Update Group
REST API: Delete Group
REST API: Get Group
REST API: Get Groups
REST API: Set Group Status
REST API: Check Forum Group Stub Availability
REST API: Forum Topics
REST API: Create Topic
REST API: Update Topic
REST API: Delete Topic
REST API: Get Topic
REST API: Set Topic Status
REST API: Check User Topic Subscription
REST API: Change User Topic Subscription
REST API: Forum Posts
REST API: Create Post
REST API: Update Post
REST API: Mark Reply as Answer
REST API: Ideas
REST API: Get Idea Votes
REST API: Get My Idea Vote
REST API: Upvote Idea
REST API: Downvote Idea
REST API: Get Idea Stages
REST API: Check Idea Stage Availability
REST API: Polls and Surveys
REST API: Get Poll
REST API: Get Polls
REST API: Get Poll Results
REST API: Vote for Poll
REST API: Create Poll
REST API: Add Poll Choice Image
REST API: Delete Poll
REST API: Add Task List
REST API: Update Task List
REST API: Update Task Sort Order
REST API: Delete Task List
REST API: Get Task List
REST API: Get Task Lists
REST API: Add Task
REST API: Update Task Priority
REST API: Update Task Status
REST API: Update Task Followers
REST API: Update Task Assigned User
REST API: Delete Task
REST API: Get Task
REST API: Get Tasks
REST API: Get Tasks In List
REST API: Get Task Followers
REST API: Add Task Time Log
REST API: Delete Task Time Log
REST API: Get Task Time Log
REST API: Get Task Time Logs
REST API: Add Task Comment
REST API: Update Task Comment
REST API: Delete Task Comment
REST API: Get Task Comments
REST API: Get Space Task Priorities
REST API: Get Space Task Statuses
REST API: Videos
REST API: Create Video
REST API: Update Video
REST API: Wall Posts
REST API: Create Wall Post
REST API: Create Wall Post Comment
REST API: Delete Wall Post
REST API: Delete Wall Post Comment
REST API: Get Wall Post
REST API: Get User's Wall Posts
REST API: Get Space Wall Posts
REST API: Add Wall Post Attachment
REST API: Get Link Metadata
REST API: Get Video Player HTML
REST API: Get User's Wall Post Count
REST API: Get Space Wall Post Count
REST API: Get Activity Stream
REST API: Get Activity Stream of a User
REST API: Get Activity Ticker of a Space
REST API: Get Activity Ticker of a User
REST API: Abuse Reports
REST API: Get Abuse Report Types
REST API: Get Abuse Report
REST API: Report Abusive Content
REST API: Bookmarks
REST API: Create Bookmark
REST API: Update Bookmark
REST API: Delete Bookmark
REST API: Content Likes
REST API: Get Content Likes
REST API: Like Content
REST API: Unlike Content
REST API: Dislike Content
REST API: Undislike Content
REST API: Tags
REST API: Get Tags
REST API: Add Tags
REST API: Get Tag Groups
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
REST API: Space Overview
REST API: Create Space
REST API: Update Space
REST API: Delete Space
REST API: Add Space Image
REST API: Set Space Status
REST API: Space Availability
REST API: Check Space Moderation
REST API: Get Space
REST API: Get My Spaces
REST API: Get All Spaces
REST API: Get Child Spaces
REST API: Get Space URL
REST API: Get User Membership Status
REST API: Add Space User
REST API: Bulk Add Users to Spaces
REST API: Delete User From Space
REST API: Approve/Decline Space User
REST API: Get User Space IDs
REST API: Get Space Users
REST API: Get Space Analytics
REST API: Get My Spaces Analytics
REST API: Space Roles
REST API: Add Space Role
REST API: Update Space Role
REST API: Delete Space Role
REST API: Get Space Roles
REST API: Get Space Role
REST API: Get Space Role By Role Name
REST API: Get User's Space Roles
REST API: Assign Space Role
REST API: Unassign Space Role
REST API: Delete All Space Roles of User
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
REST API: Add Message
REST API: Get Message
REST API: Get Messages
REST API: Edit Message
REST API: Delete Message
REST API: Mark Message As Read
REST API: Add Message Thread
REST API: Add Thread Participants
REST API: Get Message Thread
REST API: Get Recent Message Threads
REST API: Mark Thread As Favorite
REST API: Set Online Chat Status
REST API: Configure Chat Notifications Sound
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 a certain idea to management? Compile others' thoughts on the idea using Get Comment List.
REST API: Comment
REST API: Comment Overview
REST API: Create Comment
REST API: Update Comment
REST API: Delete Comment
REST API: Get Comment
REST API: Get Comment List
REST API: Set Comment Status
REST API: Comment Attachments
REST API: Add Comment Attachments
REST API: Get Comment Attachments
The Permissions REST API includes methods to check a user's permissions and update a specific role's permissions.
REST API: Permissions
REST API: Permission Types
REST API: Check Permissions
REST API: Update Permissions
The Recongition REST API includes method to get recognition programs, badges, challenges, and leaderboard users; get insights for a specific user; and recognize a user.
REST API: Get Recognition Programs
REST API: Get Awards
REST API: Get Challenges
REST API: Get Leaderboard Users
REST API: Get Recognition Insights
REST API: Recognize User
Please enable JavaScript to use file uploader.
is requesting access to a wiki that you have locked: https://my.axerosolutions.com/spaces/5/communifire-documentation/wiki/view/370/rest-api