GET
/
use-cases
/
{use_case_id}
/
runs
curl --request GET \
  --url https://platform.happyrobot.ai/api/v1/use-cases/{use_case_id}/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": {},
    "issuesCount": 123,
    "version": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slug": "<string>",
      "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "use_case_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "version_number": 123,
      "name": "<string>",
      "is_published": true,
      "is_live": true,
      "source_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "timestamp": "2023-11-07T05:31:56Z",
      "published_at": "2023-11-07T05:31:56Z",
      "is_deleted": true,
      "description": "<string>",
      "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  }
]

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.

Path Parameters

​
use_case_id
string
required

Query Parameters

​
limit
string
​
offset
string
​
sort
enum<string>
default:desc

The sort order of the runs. Defaults to desc.

Available options:
asc,
desc
Example:

"desc"

Response

200
application/json
200
​
id
string
required
​
org_id
string
required
​
use_case_id
string
required
​
version_id
string
required
​
status
enum<string>
required
Available options:
scheduled,
running,
completed,
canceled,
failed
​
annotation
enum<string> | null
required
Available options:
correct,
incorrect,
critical
​
timestamp
string
required
​
data
object
required
​
issuesCount
number
required
​
version
object
required

Was this page helpful?