Skip to main content
GET
List a bot's runs

Authorizations

Authorization
string
header
required

The session token of an admin of your company. Company API, partner and droplet installation tokens are refused.

Path Parameters

bot_id
string<uuid>
required

The bot's id.

Query Parameters

filter[status]
enum<string>

Only runs with this status.

Available options:
running,
parked,
succeeded,
failed,
refused
filter[trigger_kind]
enum<string>

Only runs started this way.

Available options:
manual,
mention
page[limit]
integer

Runs per page, 1 to 100. Defaults to 25.

Required range: 1 <= x <= 100
page[cursor]
string

A cursor from meta.pagination, to read another page.

Response

A page of runs.

runs
object[]
required

A page of runs, newest first.

status
integer
required

The HTTP status.

meta
object
required

Response metadata on every body. List endpoints add pagination.