groups

Endpoints related to groups, including LDAP-synced and custom groups.

📄️Delete a link for LDAP group

##### Permissions

📄️Get groups

Retrieve a list of all groups not associated to a particular channel or team.

📄️Create a custom group

Create a `custom` type group.

📄️Get a group

Get group from the provided group id string

📄️Deletes a custom group

Soft deletes a custom group.

📄️Patch a group

Partially update a group by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored.

📄️Restore a previously deleted group.

Restores a previously deleted custom group, allowing it to be used normally.

📄️Link a team to a group

Link a team to a group.

📄️Unlink a team from a group

Delete a link between a team and a group.

📄️Link a channel to a group

Link a channel to a group.

📄️Unlink a channel from a group

Delete a link between a channel and a group.

📄️Get a team syncable for a group

Get the GroupSyncableTeam object with the provided group and team identifiers.

📄️Get a channel syncable for a group

Get the GroupSyncableChannel object with the provided group and channel identifiers.

📄️Get team syncables for a group

Retrieve the list of team syncables associated with the group.

📄️Get channel syncables for a group

Retrieve the list of channel syncables associated with the group.

📄️Patch a team syncable for a group

Partially update a GroupSyncableTeam by providing only the fields you want to update. Omitted fields will not be updated.

📄️Patch a channel syncable for a group

Partially update a GroupSyncableChannel by providing only the fields you want to update. Omitted fields will not be updated.

📄️Get group users

Retrieve the list of users associated with a given group.

📄️Removes members from a custom group

Soft deletes a custom group members.

📄️Adds members to a custom group

Adds members to a custom group.

📄️Get group stats

Retrieve the stats of a given group.

📄️Get channel groups

Retrieve the list of groups associated with a given channel.

📄️Get team groups

Retrieve the list of groups associated with a given team.

📄️Get team groups by channels

Retrieve the set of groups associated with the channels in the given team grouped by channel.

📄️Get groups for a userId

Retrieve the list of groups associated to the user

📄️Get groups by name

Get a list of groups based on a provided list of names.