GET
/
use-cases
/
{use_case_id}
curl --request GET \
  --url https://platform.happyrobot.ai/api/v1/use-cases/{use_case_id} \
  --header 'authorization: <authorization>' \
  --header 'x-organization-id: <x-organization-id>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "icon": "<string>",
  "name": "<string>",
  "source_use_case_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "slug": "<string>",
  "order": 123,
  "run_columns": [
    {
      "group_id": "<string>",
      "variable_id": "<string>",
      "name": "<string>"
    }
  ],
  "timestamp": "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.

Path Parameters

​
use_case_id
string
required

Response

200
application/json
200

A use case.

​
id
string
required
​
org_id
string
required
​
icon
string
required
Maximum length: 256
​
name
string
required
Maximum length: 256
​
source_use_case_version_id
string | null
required
​
slug
string
required
Maximum length: 256
​
order
number | null
required
​
run_columns
object[]
required
​
timestamp
string
required

Was this page helpful?