Skip to main content
GET
/
v1
/
sim-suites
/
{suite_id}
Get a simulation suite
curl --request GET \
  --url https://api-sandbox.featherhq.com/v1/sim-suites/{suite_id} \
  --header 'x-api-key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "is_active": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "created_by": "<string>",
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "suite_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "persona_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "scenario_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
suite_id
string<uuid>
required

Response

Successful Response

​
id
string<uuid>
required
​
organization_id
string<uuid>
required
​
name
string
required
​
is_active
boolean
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
description
string | null
​
created_by
string | null
​
items
SimulationSuiteItemResponse · object[]