Sign in

v46

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

Get playbook run metadata

get/plugins/playbooks/api/v0/runs/{id}/metadata

Path parameters

idstring required
Example:mx3xyzdojfgyfdx8sc8of1gdme

ID of the playbook run whose metadata will be retrieved.

Response

Playbook run metadata.

channel_namestring

Name of the channel associated to the playbook run.

channel_display_namestring

Display name of the channel associated to the playbook run.

team_namestring

Name of the team the playbook run is in.

num_membersinteger

Number of users that have been members of the playbook run at any point.

total_postsinteger

Number of posts in the channel associated to the playbook run.

Example response

{
  "channel_name": "server-down-in-eu-cluster",
  "channel_display_name": "Server down in EU cluster",
  "team_name": "sre-staff",
  "num_members": 25,
  "total_posts": 202
}