groups

Get groups

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

not_associated_to_team OR not_associated_to_channel is required.

If you use not_associated_to_team, you must be a team admin for that particular team (permission to manage that team).

If you use not_associated_to_channel, you must be a channel admin for that particular channel (permission to manage that channel).

n

get/api/v4/groups

Query parameters

pageinteger

The page to select.

per_pageinteger

The number of groups per page.

qstring

String to pattern match the name and display_name field. Will return all groups whose name and display_name field match any of the text.

include_member_countboolean

Boolean which adds the member_count attribute to each group JSON object

not_associated_to_teamstring required

Team GUID which is used to return all the groups not associated to this team

not_associated_to_channelstring required

Group GUID which is used to return all the groups not associated to this channel

sinceinteger

Only return groups that have been modified since the given Unix timestamp (in milliseconds). All modified groups, including deleted and created groups, will be returned. n

filter_allow_referenceboolean

Boolean which filters the group entries with the allow_reference attribute set.

Response

Group list retrieval successful

idstring
namestring
display_namestring
descriptionstring
sourcestring
remote_idstring
create_atinteger
update_atinteger
delete_atinteger
has_syncablesboolean

Changes

No recorded changes to this endpoint across all 1 revision of this API.