Groups

REST API Groups Methods

Url

Short Description

Details Page

/api/v1/groups.addAll

Adds all of the users on the server to a private group.

Link

/api/v1/groups.addLeader

Gives the role of Leader for a user in the current group.

Link

/api/v1/groups.addModerator

Gives the role of moderator to a user in a group.

Link

/api/v1/groups.addOwner

Gives the role of owner to a user in a group.

Link

/api/v1/groups.archive

Archives a private group.

Link

/api/v1/groups.close

Removes a private group from the list of groups.

Link

/api/v1/groups.counters

Gets group counters.

Link

/api/v1/groups.create

Creates a new private group.

Link

/api/v1/groups.delete

Removes a private group.

Link

/api/v1/groups.files

Gets a list of files from a private group.

Link

/api/v1/groups.getIntegrations

Gets the integrations assigned to the group.

Link

/api/v1/groups.history

Retrieves the messages from a private group.

Link

/api/v1/groups.info

Gets the information about a private group.

Link

/api/v1/groups.invite

Adds a user to the private group.

Link

/api/v1/groups.kick

Removes a user from a private group.

Link

/api/v1/groups.leave

Removes the calling user from the private group.

Link

/api/v1/groups.list

List the private groups the caller is part of.

Link

/api/v1/groups.listAll

List all the private groups.

Link

/api/v1/groups.moderators

List all moderators of a group.

Link

/api/v1/groups.members

Gets the users of participants of a private group.

Link

/api/v1/groups.messages

Retrieves all group messages.

Link

/api/v1/groups.open

Adds the private group back to the list of groups.

Link

/api/v1/groups.removeLeader

Removes the role of Leader for a user in the current group.

Link

/api/v1/groups.removeModerator

Removes the role of moderator from a user in a group.

Link

/api/v1/groups.removeOwner

Removes the role of owner from a user in a group.

Link

/api/v1/groups.rename

Changes the name of the private group.

Link

/api/v1/groups.roles

Gets the user's roles in the private group.

Link

/api/v1/groups.setAnnouncement

Sets a group's announcement.

Link

/api/v1/groups.setCustomFields

Sets private group's custom fields.

Link

/api/v1/groups.setDescription

Sets a private group's description.

Link

/api/v1/groups.setPurpose

Sets a private group's description.

Link

/api/v1/groups.setReadOnly

Sets whether the room is read only or not.

Link

/api/v1/groups.setTopic

Sets a private group's topic.

Link

/api/v1/groups.setType

Sets the type of room this group will be.

Link

/api/v1/groups.unarchive

Unarchives a private group.

Link

Edit on GitHub