Automations

List an automation's runs

List an automation's runs, newest first by default, with what started each one, how it ended, and why a failed run failed.

get/automations/{id}/runs

Request

  • Base URL
    https://api.parley.so/v1
  • URL
    https://api.parley.so/v1/automations/{id}/runs
  • Auth
    HTTP bearer

Path parameters

idstring required

The automation ID.

Query parameters

status'pending' | 'running' | 'succeeded' | 'failed' | 'canceled' | 'timed_out'

Only runs with this status.

sort'createdAt' | '-createdAt'

Sort order: a field name, prefixed with - for descending. Defaults to -createdAt.

cursorstring

Opaque cursor from nextCursor. Pass the same filters and sort. Omit for the first page.

limitinteger

Maximum number of items to return.

Response

OK

nextCursorstring nullable required

Cursor for the next page, or null on the last page.

Changes

No recorded changes to this operation across all 2 revisions of this API.