Runs

Returns paginated recent (non-archived) runs across the caller's organization, every member's runs included. Filters: agent_id, search (run ID substring), status, trigger. Order with order_by ('<field> <asc|desc>'), field one of status, started_at, completed_at, created_at.

get/runs

Request

Query parameters

agent_idstring uuid

Only runs of this agent.

schedule_idstring uuid

Only runs this schedule started.

mode'agent' | 'code'

Only runs of this mode.

device_class'phone'

Only runs that drove this kind of device.

limitinteger

Maximum number of runs to return per page (1-500).

offsetinteger

Pagination offset.

searchstring

Filter by run id substring.

statusstring[] nullable

Only runs at one of these statuses; repeatable.

triggerstring[] nullable

Only runs started by one of these triggers; repeatable.

order_bystring

Sort expression '<field> [asc|desc]', direction defaulting to desc; field is status, started_at, completed_at or created_at. Defaults to created_at desc.

Response

OK

limitinteger required

Page size used for this response.

offsetinteger required

Pagination offset used for this response.

totalinteger required

Total number of runs matching the query.

Changes

    • breaking

      removed the required property // from the response with the status

    • warning

      deleted the query request parameter workflow_id

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      added the new paused enum value to the // response property for the response status

    • info

      added the new optional query request parameter agent_id

    • info

      added the new optional query request parameter device_class

    • info

      added the new optional query request parameter mode

    • info

      added the new optional query request parameter schedule_id

    • info

      added the enum value paused to the property items/ of the query request parameter status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status

    • breaking

      added the pattern ^(status|started_at|completed_at|created_at)( (asc|desc))?$ to the query request parameter order_by

    • warning

      deleted the query request parameter status_filter

    • warning

      deleted the query request parameter trigger_filter

    • warning

      removed the optional property // from the response with the status

    • info

      added the new optional query request parameter status

    • info

      added the new optional query request parameter trigger

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property // to the response with the status