REST API for Collaboration

People and Groups REST Endpoints

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}

People and Groups

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

Get a list of all enabled groups.: Method: get

Path: /social/api/v1/groups
Create a new group.: Method: post

Path: /social/api/v1/groups
Delete the specified group.: Method: delete

Path: /social/api/v1/groups/{groupID}
Get the specified group.: Method: get

Path: /social/api/v1/groups/{groupID}
Update the specified group.: Method: patch

Path: /social/api/v1/groups/{groupID}
Update the specified group.: Method: put

Path: /social/api/v1/groups/{groupID}
Get the direct members of the specified group.: Method: get

Path: /social/api/v1/groups/{groupID}/members
Add a new member to the specified group.: Method: post

Path: /social/api/v1/groups/{groupID}/members
Remove the specified member from the specified group.: Method: delete

Path: /social/api/v1/groups/{groupID}/members/{memberID}
Get the specified member of the specified group.: Method: get

Path: /social/api/v1/groups/{groupID}/members/{memberID}
Add the specified member to the specified group.: Method: post

Path: /social/api/v1/groups/{groupID}/members/{memberID}
Get all direct and indirect user members of the specified group.: Method: get

Path: /social/api/v1/groups/{groupID}/memberships
Get a list of all enabled users.: Method: get

Path: /social/api/v1/people
Create a new user.: Method: post

Path: /social/api/v1/people
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}
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}
Get the specified user.: Method: get

Path: /social/api/v1/people/{peopleID}
Update the specified user.: Method: patch

Path: /social/api/v1/people/{peopleID}
Update the specified user.: Method: put

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
Get all followers of the specified user.: Method: get

Path: /social/api/v1/people/{peopleID}/followers
Add the current user as a follower of the specified user.: Method: post

Path: /social/api/v1/people/{peopleID}/followers
Get all users followed by the specified user.: Method: get

Path: /social/api/v1/people/{peopleID}/following
Get all properties for the specified user.: Method: get

Path: /social/api/v1/people/{peopleID}/properties
Set a new property for the specified user.: Method: post

Path: /social/api/v1/people/{peopleID}/properties
Remove the specified property of the specified user.: Method: delete

Path: /social/api/v1/people/{peopleID}/properties/{propertyID}
Get the specified property for the specified user.: Method: get

Path: /social/api/v1/people/{peopleID}/properties/{propertyID}
Set the specified property for the specified user.: Method: post

Path: /social/api/v1/people/{peopleID}/properties/{propertyID}
Get a filtered list of statistics.: Method: get

Path: /social/api/v1/people/{peopleID}/statistics
Remove the picture for the specified object.: Method: delete

Path: /social/api/v1/pictures/{pictureID}
Get the picture for the specified object.: Method: get

Path: /social/api/v1/pictures/{pictureID}
Update the picture for the specified object.: Method: put

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

People and Groups

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

Delete the specified group.: Method: delete

Path: /social/api/v1/groups/{groupID}
Remove the specified member from the specified group.: Method: delete

Path: /social/api/v1/groups/{groupID}/members/{memberID}
Remove the current user as a follower of the specified user.: Method: delete

Path: /social/api/v1/people/{peopleID}/followers
Remove the specified property of the specified user.: Method: delete

Path: /social/api/v1/people/{peopleID}/properties/{propertyID}
Remove the picture for the specified object.: Method: delete

Path: /social/api/v1/pictures/{pictureID}
Get a list of all enabled groups.: Method: get

Path: /social/api/v1/groups
Get the specified group.: Method: get

Path: /social/api/v1/groups/{groupID}
Get the direct members of the specified group.: Method: get

Path: /social/api/v1/groups/{groupID}/members
Get the specified member of the specified group.: Method: get

Path: /social/api/v1/groups/{groupID}/members/{memberID}
Get all direct and indirect user members of the specified group.: Method: get

Path: /social/api/v1/groups/{groupID}/memberships
Get a list of all enabled users.: Method: get

Path: /social/api/v1/people
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 specified user.: Method: get

Path: /social/api/v1/people/{peopleID}
Get all followers of the specified user.: Method: get

Path: /social/api/v1/people/{peopleID}/followers
Get all users followed by the specified user.: Method: get

Path: /social/api/v1/people/{peopleID}/following
Get all properties for the specified user.: Method: get

Path: /social/api/v1/people/{peopleID}/properties
Get the specified property for the specified user.: Method: get

Path: /social/api/v1/people/{peopleID}/properties/{propertyID}
Get a filtered list of statistics.: Method: get

Path: /social/api/v1/people/{peopleID}/statistics
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
Update the specified group.: Method: patch

Path: /social/api/v1/groups/{groupID}
Update the specified user.: Method: patch

Path: /social/api/v1/people/{peopleID}
Create a new group.: Method: post

Path: /social/api/v1/groups
Add a new member to the specified group.: Method: post

Path: /social/api/v1/groups/{groupID}/members
Add the specified member to the specified group.: Method: post

Path: /social/api/v1/groups/{groupID}/members/{memberID}
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}
Add the current user as a follower of the specified user.: Method: post

Path: /social/api/v1/people/{peopleID}/followers
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 specified group.: Method: put

Path: /social/api/v1/groups/{groupID}
Update the specified user.: Method: put

Path: /social/api/v1/people/{peopleID}
Update the picture for the specified object.: Method: put

Path: /social/api/v1/pictures/{pictureID}