API Reference


Groups are used to organize media and users into flexible, customized containers. They are searchable, support custom meta-data and can be manually ordered for display.
Groups.addMember

Adds a member to a group.

This can be used by the public to add themselves to groups within the vhosts their user is in. This requires the user to be logged in. In this case both "uid" and "memberType" should be left as their defaults.

This may also be used by privileged users (those with the groups.addMember permission) to add other users within the group's vhost to a group read more »

Groups.createGroup

This method returns the new group id.


Deleting a Group

NB: To delete a group, you use the function updateGroup, and set the moderationStatus to deleted.
read more »
Groups.getGroup

Returns group information for a specific group ID.

read more »
Groups.getGroups

Returns a list of groups for a specific vhost

Pagination may be controlled via the "startPage" and "pageSize" parameters

The optional "sort" argument is a string that can be used to specify one field to sort the returned groups by.The sort parameter can also include a sort direction ("ASC" or "DESC").

All groups returned will have a last resort sort applied based on the read more »

Groups.isMediaInGroup

Checks whether a media item is in a group.

A simple boolean will be returned, true if the media item is in the group, false otherwise.

read more »
Groups.removeMember

Removes a member from a group

This can be used by registered users to remove themselves from a group they're a member of. In this case the "uid" parameter should be left as its default.

This may also be used by privileged users (those with the groups.removeMember permission) to remove other users within the group's vhost from an group.

read more »
Groups.updateGroup

Updates group information based on a group ID


Deleting a Group

NB: To delete a group, you use the function updateGroup, and set the moderationStatus to deleted.
read more »
Groups.updateMember

Updates a member's status in a group.

This can be used to promote a member to admin, or demotion.

read more »
Groups.getGroupTree

Returns a tree of all groups and events.

If the moderation status filter is set then only groups with the given moderation status will be returned. If a group does not have the given moderation status and does have children then its children will not be returned.

If the parent group filter is set then only children of the specified parent will be returned.

read more »
Groups.isUserInGroup

Checks whether a user is in an group.

A simple boolean will be returned, true if the user is in the group, false otherwise.

If includeChildren is true then this function will return true if the user is in the group specified or any of its descendants.

read more »
Groups.addMedia

Adds a media item to a group.

read more »
Groups.removeMedia

Removes a media item from a group.

read more »
Groups.addMembersToGroupByFilters
This method adds multiple users to a group based on supplied parameters. It supports the same filters at users.getUsers read more »
Groups.moveMediaToGroup

Moves a media to a Group, removeing it from all other groups.

This API call Requires permissions of the same name;

read more »