REST API for Collaboration

All REST Endpoints

Collaboration

Enable collaboration among users through conversations.

Add new members to the specified conversation.: Method: post
Path: /social/api/v1/conversations/{conversationID}/members
Add the specified member to the specified conversation.: Method: post
Path: /social/api/v1/conversations/{conversationID}/members/{memberID}
Associate a document with the specified conversation.: Method: post
Path: /social/api/v1/conversations/{conversationID}/associate
Close the followup on the specified message for the specified user.: Method: delete
Path: /social/api/v1/messages/{messageID}/followups/{userID}
Create a new applink for the specified conversation.: Method: post
Path: /social/api/v1/conversations/{conversationID}/applinks
Create a new conversation.: Method: post
Path: /social/api/v1/conversations
Create a new hybrid link for the specified conversation.: Method: post
Path: /social/api/v1/conversations/{conversationID}/hybridlinks
Create a new reply to the specified message.: Method: post
Path: /social/api/v1/messages/{messageID}
Create a new top-level message in the specified conversation.: Method: post
Path: /social/api/v1/conversations/{conversationID}/messages
Create hybrid links.: Method: post
Path: /social/api/v1/hybridlinks
Create new followups on the specified message.: Method: post
Path: /social/api/v1/messages/{messageID}/followups
Create the inbound mail token information.: Method: post
Path: /social/api/v1/inboundmail/token
Delete the hybrid link for the specified hybrid link ID.: Method: delete
Path: /social/api/v1/conversations/{conversationID}/hybridlinks/{hybridlinkID}
Delete the hybrid links.: Method: delete
Path: /social/api/v1/hybridlinks
Delete the specified hybrid link.: Method: delete
Path: /social/api/v1/hybridlinks/{hybridlinkID}
Get a filtered list of all conversations.: Method: get
Path: /social/api/v1/conversations
Get a filtered list of hybrid links.: Method: get
Path: /social/api/v1/hybridlinks
Get a list of folder IDs that have conversations associated with them.: Method: get
Path: /social/api/v1/hierarchicalMembers/{hierarchicalMemberID}
Get all direct and indirect user members of the specified conversation.: Method: get
Path: /social/api/v1/conversations/{conversationID}/memberships
Get all direct members of the specified conversation.: Method: get
Path: /social/api/v1/conversations/{conversationID}/members
Get all followups for the specified message.: Method: get
Path: /social/api/v1/messages/{messageID}/followups
Get all likes for the specified conversation.: Method: get
Path: /social/api/v1/conversations/{conversationID}/likes
Get all likes for the specified message.: Method: get
Path: /social/api/v1/messages/{messageID}/likes
Get all members of the specified conversation.: Method: get
Path: /social/api/v1/conversations/{conversationID}/allmemberships
Get all properties of the specified conversation.: Method: get
Path: /social/api/v1/conversations/{conversationID}/properties
Get all stars for the specified conversation.: Method: get
Path: /social/api/v1/conversations/{conversationID}/stars
Get all top-level messages of the specified conversation.: Method: get
Path: /social/api/v1/conversations/{conversationID}/messages
Get all user properties of the specified conversation.: Method: get
Path: /social/api/v1/conversations/{conversationID}/userProperties
Get an archive for the specified conversation.: Method: get
Path: /social/api/v1/conversations/{conversationID}/archive
Get any followup for the specified user for the specified message.: Method: get
Path: /social/api/v1/messages/{messageID}/followups/{userID}
Get around chats after the specified message.: Method: get
Path: /social/api/v1/messages/{messageID}/around
Get the next chats after the specified message.: Method: get
Path: /social/api/v1/messages/{messageID}/next
Get the previous chats after the specified message.: Method: get
Path: /social/api/v1/messages/{messageID}/previous
Get the specified conversation.: Method: get
Path: /social/api/v1/conversations/{conversationID}
Get the specified hybrid link.: Method: get
Path: /social/api/v1/hybridlinks/{hybridlinkID}
Get the specified member of the specified conversation.: Method: get
Path: /social/api/v1/conversations/{conversationID}/allmemberships/{allmembershipID}
Get the specified member of the specified conversation.: Method: get
Path: /social/api/v1/conversations/{conversationID}/members/{memberID}
Get the specified message.: Method: get
Path: /social/api/v1/messages/{messageID}
Get the specified property of the specified conversation.: Method: get
Path: /social/api/v1/conversations/{conversationID}/properties/{propertyID}
Get the specified user properties on the specified conversation.: Method: get
Path: /social/api/v1/conversations/{conversationID}/userProperties/{userPropertyID}
Get whether this message is starred.: Method: get
Path: /social/api/v1/messages/{messageID}/stars
Like the specified message.: Method: post
Path: /social/api/v1/messages/{messageID}/likes
Mark the followup for the current user on the specified message as read. This does not close the followup.: Method: put
Path: /social/api/v1/messages/{messageID}/followups
Remove the specified member from the specified conversation.: Method: delete
Path: /social/api/v1/conversations/{conversationID}/members/{memberID}
Remove the specified property from the specified conversation.: Method: delete
Path: /social/api/v1/conversations/{conversationID}/properties/{propertyID}
Remove the specified user properties from the specified conversation.: Method: delete
Path: /social/api/v1/conversations/{conversationID}/userProperties/{userPropertyID}
Set a property on the specified conversation.: Method: post
Path: /social/api/v1/conversations/{conversationID}/properties
Set a user property on the specified conversation.: Method: post
Path: /social/api/v1/conversations/{conversationID}/userProperties
Set the specified property on the specified conversation.: Method: post
Path: /social/api/v1/conversations/{conversationID}/properties/{propertyID}
Set the specified user properties on the specified conversation.: Method: post
Path: /social/api/v1/conversations/{conversationID}/userProperties/{userPropertyID}
Star the specified conversation.: Method: post
Path: /social/api/v1/conversations/{conversationID}/stars
Star the specified message.: Method: post
Path: /social/api/v1/messages/{messageID}/stars
This will always return an empty list; provided for compliance with REST standards.: Method: get
Path: /social/api/v1/conversations/{conversationID}/applinks
This will always return an empty list; provided for compliance with REST standards.: Method: get
Path: /social/api/v1/conversations/{conversationID}/hybridlinks
Un-like the specified message.: Method: delete
Path: /social/api/v1/messages/{messageID}/likes
Un-star the specified conversation.: Method: delete
Path: /social/api/v1/conversations/{conversationID}/stars
Un-star the specified message.: Method: delete
Path: /social/api/v1/messages/{messageID}/stars
Update or create the specified hierarchical members.: Method: put
Path: /social/api/v1/hierarchicalMembers/{hierarchicalMemberID}
Update the specified conversation.: Method: patch
Path: /social/api/v1/conversations/{conversationID}
Update the specified conversation.: Method: put
Path: /social/api/v1/conversations/{conversationID}
Update the specified hierarchical members.: Method: patch
Path: /social/api/v1/hierarchicalMembers/{hierarchicalMemberID}
Update the specified message.: Method: patch
Path: /social/api/v1/messages/{messageID}
Update the specified message.: Method: put
Path: /social/api/v1/messages/{messageID}

Configuration

Configure resources and services.

Get all configuration properties.: Method: get
Path: /social/api/v1/configuration
Get the specified configuration property.: Method: get
Path: /social/api/v1/configuration/{configurationID}
Remove the specified configuration property.: Method: delete
Path: /social/api/v1/configuration/{configurationID}
Set a configuration property.: Method: post
Path: /social/api/v1/configuration
Set the specified configuration property.: Method: post
Path: /social/api/v1/configuration/{configurationID}

People and Groups

Manage users, groups of users, and one-on-one conversations.

Add a new member to the specified group.: Method: post
Path: /social/api/v1/groups/{groupID}/members
Add the current user as a follower of the specified user.: Method: post
Path: /social/api/v1/people/{peopleID}/followers
Add the specified member to the specified group.: Method: post
Path: /social/api/v1/groups/{groupID}/members/{memberID}
Create a new group.: Method: post
Path: /social/api/v1/groups
Create a new user.: Method: post
Path: /social/api/v1/people
Create the one-on-one conversation for the specified users. This method will create the one-on-one conversation if it does not already exist. Currently property update information is not being consumed by the API to update any property.: Method: post
Path: /social/api/v1/people/{firstPersonID}/chats/{secondPersonID}
Delete the specified group.: Method: delete
Path: /social/api/v1/groups/{groupID}
Get a filtered list of statistics.: Method: get
Path: /social/api/v1/people/{peopleID}/statistics
Get a list of all enabled groups.: Method: get
Path: /social/api/v1/groups
Get a list of all enabled users.: Method: get
Path: /social/api/v1/people
Get all direct and indirect user members of the specified group.: Method: get
Path: /social/api/v1/groups/{groupID}/memberships
Get all followers of the specified user.: Method: get
Path: /social/api/v1/people/{peopleID}/followers
Get all properties for the specified user.: Method: get
Path: /social/api/v1/people/{peopleID}/properties
Get all users followed by the specified user.: Method: get
Path: /social/api/v1/people/{peopleID}/following
Get the direct members of the specified group.: Method: get
Path: /social/api/v1/groups/{groupID}/members
Get the one-on-one conversation for the specified users. This method does not create the one-on-one conversation if it does not already exist.: Method: get
Path: /social/api/v1/people/{firstPersonID}/chats/{secondPersonID}
Get the picture for the specified object.: Method: get
Path: /social/api/v1/pictures/{pictureID}
Get the profile picture for the specified object.: Method: get
Path: /social/api/v1/pictures/{pictureID}/profile
Get the scaled picture for the specified object.: Method: get
Path: /social/api/v1/pictures/{pictureID}/scaled
Get the specified group.: Method: get
Path: /social/api/v1/groups/{groupID}
Get the specified member of the specified group.: Method: get
Path: /social/api/v1/groups/{groupID}/members/{memberID}
Get the specified property for the specified user.: Method: get
Path: /social/api/v1/people/{peopleID}/properties/{propertyID}
Get the specified user.: Method: get
Path: /social/api/v1/people/{peopleID}
Remove the current user as a follower of the specified user.: Method: delete
Path: /social/api/v1/people/{peopleID}/followers
Remove the picture for the specified object.: Method: delete
Path: /social/api/v1/pictures/{pictureID}
Remove the specified member from the specified group.: Method: delete
Path: /social/api/v1/groups/{groupID}/members/{memberID}
Remove the specified property of the specified user.: Method: delete
Path: /social/api/v1/people/{peopleID}/properties/{propertyID}
Set a new property for the specified user.: Method: post
Path: /social/api/v1/people/{peopleID}/properties
Set the specified property for the specified user.: Method: post
Path: /social/api/v1/people/{peopleID}/properties/{propertyID}
Update the picture for the specified object.: Method: put
Path: /social/api/v1/pictures/{pictureID}
Update the specified group.: Method: patch
Path: /social/api/v1/groups/{groupID}
Update the specified group.: Method: put
Path: /social/api/v1/groups/{groupID}
Update the specified user.: Method: patch
Path: /social/api/v1/people/{peopleID}
Update the specified user.: Method: put
Path: /social/api/v1/people/{peopleID}

Security

Manage connections and access.

Create a new connection or determine if there is an existing connection. Also used with an empty name and password to get the random ID.: Method: post
Path: /social/api/v1/connections
Determine if there is an existing connection, or return information about the connection.: Method: get
Path: /social/api/v1/connections
Disconnect an existing connection.: Method: delete
Path: /social/api/v1/connections
Update an existing connection.: Method: patch
Path: /social/api/v1/connections
Update an existing connection.: Method: put
Path: /social/api/v1/connections

Social

Mark favorite conversations and documents, and collaborate with people.

Close the specified followup.: Method: delete
Path: /social/api/v1/followups/{followupID}
Get a filtered list of all followups.: Method: get
Path: /social/api/v1/followups
Get a filtered list of all stars.: Method: get
Path: /social/api/v1/stars
Get the specified followup.: Method: get
Path: /social/api/v1/followups/{followupID}
Mark the specified followup read.: Method: put
Path: /social/api/v1/followups/{followupID}
Star the specified object.: Method: post
Path: /social/api/v1/stars/{starID}
Un-star the specified object.: Method: delete
Path: /social/api/v1/stars/{starID}