GET
/
use-cases
curl --request GET \
  --url https://app.happyrobot.ai/api/v1/use-cases \
  --header 'authorization: <authorization>'
[
  {
    "id": "<string>",
    "name": "Kate",
    "transfer_number": "<string>",
    "hidden": true,
    "evaluation_models": [
      "<string>"
    ],
    "params": {},
    "work_start": "<string>",
    "work_end": "<string>",
    "timezone": "<string>"
  }
]

Headers

​
authorization
string
required

Your API key for authentication. Use Bearer format.

Response

200
application/json
200
​
id
string
required

ID of the use case.

​
name
string

Name of the use case.

​
transfer_number
string

Fallback phone number to transfer the call to if something breaks.

​
hidden
boolean

Hide the use case from the UI.

​
evaluation_models
string[]

Models the use case is evaluated on.

​
params
object

Parameters to pass to the use case.

​
work_start
string

Start of the work hours.

​
work_end
string

End of the work hours.

​
timezone
string

Timezone of the use case.

Was this page helpful?

Create a new model and start trainingGet Use Case