Sign in
channels

Get a list of all channels

Permissions

manage_system

get/api/v4/channels

Query parameters

not_associated_to_groupstring

A group id to exclude channels that are associated with that group via GroupChannel records. This can also be left blank with not_associated_to_group=.

pageinteger

The page to select.

per_pageinteger

The number of channels per page.

exclude_default_channelsboolean

Whether to exclude default channels (ex Town Square, Off-Topic) from the results.

include_deletedboolean

Include channels that have been archived. This correlates to the DeleteAt flag being set in the database.

include_total_countboolean

Appends a total count of returned channels inside the response object - ex: { "channels": [], "total_count" : 0 }.

exclude_policy_constrainedboolean

If set to true, channels which are part of a data retention policy will be excluded. The sysconsole_read_compliance permission is required to use this parameter.

Response

Channel list retrieval successful

idstring
create_atinteger

The time in milliseconds a channel was created

update_atinteger

The time in milliseconds a channel was last updated

delete_atinteger

The time in milliseconds a channel was deleted

team_idstring
typestring
display_namestring
namestring
headerstring
purposestring
last_post_atinteger

The time in milliseconds of the last post of a channel

total_msg_countinteger
creator_idstring
team_display_namestring

The display name of the team to which this channel belongs.

team_namestring

The name of the team to which this channel belongs.

team_update_atinteger

The time at which the team to which this channel belongs was last updated.

policy_idstring

The data retention policy to which this team has been assigned. If no such policy exists, or the caller does not have the sysconsole_read_compliance_data_retention permission, this field will be null.

Changes