GET
/
runs
curl --request GET \
  --url https://platform.happyrobot.ai/api/v1/runs \
  --header 'authorization: <authorization>' \
  --header 'x-organization-id: <x-organization-id>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "use_case_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "scheduled",
    "annotation": "correct",
    "timestamp": "2023-11-07T05:31:56Z",
    "data": {},
    "completed_at": "2023-11-07T05:31:56Z"
  }
]

Headers

​
authorization
string
required

Your API key for authentication. Use Bearer format.

Example:

"Bearer API_KEY"

​
x-organization-id
string
required

The organization ID to use for the request. Required if your user is associated to more than one organization.

Query Parameters

​
limit
number | null

The number of runs to return. Defaults to 1000.

Required range: x <= 5000
Example:

1000

​
offset
number | null

The number of runs to skip. Defaults to 0.

Example:

500

​
use_case_id
string
default:
required

The ID of the use case to filter runs by. Defaults to all runs in all use cases.

​
status
enum<string>
default:success

The status of the runs to filter by.

Available options:
scheduled,
running,
completed,
canceled,
failed
​
start
string

The start date to filter runs by. Defaults to all runs.

Example:

"2024-01-01T00:00:00.000Z"

​
end
string

The end date to filter runs by. Defaults to all runs.

Example:

"2024-01-01T00:00:00.000Z"

​
sort
enum<string>
default:desc

The sort order of the runs by their timestamp (does not sort by completion date). Defaults to desc.

Available options:
asc,
desc
Example:

"desc"

​
completed_start
string

Filter runs by completion date, starting from this date. If not specified, includes runs completed at any time.

Example:

"2024-01-01T00:00:00.000Z"

​
completed_end
string

Filter runs by completion date, ending at this date. If not specified, includes runs completed at any time.

Example:

"2024-01-01T00:00:00.000Z"

​
node_output_filters
object

Filters based on a particular node output in the run. The syntax for this property is '{{node.id}}.property.to.filter.by': ['{{value}}']. The simpliest way to get the key is to add the var to your runs table and to view the keys in the data property of the /runs response. If you need assistance with this, please reach out to your HappyRobot representative.

Response

200
application/json

200

A list of runs with the data for each column you've added to your runs table.