Skip to main content
GET
/
api
/
v2
/
workspaces
/
{workspaceId}
/
gamebooks
/
by-incident
/
{incidentId}
List incident gamebooks
curl --request GET \
  --url https://api.example.com/api/v2/workspaces/{workspaceId}/gamebooks/by-incident/{incidentId}
{
  "data": [
    {
      "id": "<string>",
      "tracingId": "<string>",
      "incidentId": "<string>",
      "source": "Sentinel",
      "incidentTitle": "<string>",
      "incidentNumber": 123,
      "isOcr": true,
      "isRecover": true,
      "triggedByUserId": "<string>",
      "displayName": "<string>",
      "modificationDate": "2023-11-07T05:31:56Z",
      "creationDate": "2023-11-07T05:31:56Z",
      "status": "Pending",
      "title": "<string>",
      "isAdminRequired": true,
      "workspaceId": "<string>",
      "workspaceName": "<string>",
      "tenantId": "<string>",
      "isAutoRun": true,
      "originalGamebookId": "<string>",
      "originalGamebookTitle": "<string>",
      "isRetryGamebook": true,
      "isQueued": true,
      "playbooks": [
        {
          "id": "<string>",
          "referenceId": "<string>",
          "entityId": "<string>",
          "name": "<string>",
          "description": "<string>",
          "entityType": "User",
          "affectedEntity": "<string>",
          "isRecommended": true,
          "status": "Pending",
          "errorMessage": "<string>",
          "sequence": 123,
          "modificationDate": "2023-11-07T05:31:56Z",
          "startingDate": "2023-11-07T05:31:56Z",
          "finishingDate": "2023-11-07T05:31:56Z",
          "executionTime": "<string>",
          "tracingId": "<string>",
          "parameters": {},
          "isAdminRequired": true
        }
      ],
      "summary": "<string>"
    }
  ],
  "meta": {
    "requestId": "<string>",
    "timestamp": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.contraforce.com/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

workspaceId
string<uuid>
required
incidentId
string
required

Query Parameters

withUserDetails
boolean
required

Response

OK

Standard v2 API response envelope for single-item responses.

data
null | object[]
meta
object