Sign in

v46

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-174421106.5 KB
PlaybookRuns

Get playbook run channels

Get all channels associated with a playbook run, filtered by team, status, owner, name and/or members, and sorted by ID, name, status, creation date, end date, team, or owner ID.

get/plugins/playbooks/api/v0/runs/channels

Query parameters

team_idstring required

ID of the team to filter by.

sort'id' | 'name' | 'create_at' | 'end_at' | 'team_id' | 'owner_user_id'

Field to sort the returned channels by, according to their playbook run.

direction'desc' | 'asc'

Direction (ascending or descending) followed by the sorting of the playbook runs associated to the channels.

status'all' | 'InProgress' | 'Finished'

The returned list will contain only the channels whose playbook run has this status.

owner_user_idstring

The returned list will contain only the channels whose playbook run is commanded by this user.

search_termstring

The returned list will contain only the channels associated to a playbook run whose name contains the search term.

participant_idstring

The returned list will contain only the channels associated to a playbook run for which the given user is a participant.

Response

Channel IDs.

string[] required

Example response

[
  "v8zdc1893plelmf54vb7f0ramn"
]