channels

Search channels

Search public channels on a team based on the search term provided in the request body.

Permissions

Must have the list_team_channels permission.

A user without the list_team_channels permission will be able to use this endpoint, with the search results limited to the channels that the user is a member of.

post/api/v4/teams/{team_id}/channels/search

Path parameters

team_idstring required

Team GUID

Request body

termstring required

The search term to match against the name or display name of channels

Response

Channels search 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

Changes

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