List automation runs

Request

List runs for a project, newest first unless sortOrder says otherwise. Each run includes its automation's name and what triggered it. Get a run to read its run prompt and the saved instructions it used.

Security

ApiKey(Required scopes: automations.list)

Query

projectIdstring, non-emptyrequired

Project to list runs from

automationIdArray of strings

Filter runs to these automations within the project. Provide as a comma-separated list.

statusArray of strings

Filter runs to these statuses. Provide as a comma-separated list.

Items Enum:"pending""running""succeeded""failed"

createdAfterstring, (date-time)

Only include runs created at or after this time

createdBeforestring, (date-time)

Only include runs created at or before this time

sortBystring

Field to sort runs by

Default:"createdAt"

Value:"createdAt"

sortOrderstring

Sort order for the sortBy field

Enum:"asc""desc"

ownerMemberIdstring, non-empty

Filter runs to automations owned by this org member. Use me for the member the caller acts as. Organization API keys cannot use me.

limitnumber, [ 0 .. 2000 ]

Maximum number of items to return

Default:2000

offsetinteger, >= 0

Number of items to skip before returning the results

Default:0

Payload

// No request payload

Responses

List of runs

Bodyapplication/json

runsArray of objects(AutomationRunSummary)required

Response

{
  "runs": [
    { … }
  ]
}