Skip to main content
GET
/
playbooks
/
{id}
/
checks
List a playbook's checks
curl --request GET \
  --url https://app.gc.ai/api/external/v1/playbooks/{id}/checks \
  --header 'Authorization: <api-key>'
{
  "checks": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "description": "<string>",
      "positions": [
        {
          "guidance": "<string>"
        }
      ],
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Format: gcai_xxxxxxxxx

Create API keys in the GC AI app under Settings → API.

Path Parameters

​
id
string<uuid>
required

Playbook ID from GET /playbooks.

Response

List of checks

​
checks
object[]
required