Skip to main content
GET
/
api
/
v2
/
workspaces
/
{workspaceId}
/
gamebooks
/
history
/
{gamebookId}
/
playbooks
Get playbooks by gamebook id
curl --request GET \
  --url https://api.example.com/api/v2/workspaces/{workspaceId}/gamebooks/history/{gamebookId}/playbooks
{
  "data": [
    {
      "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
    }
  ],
  "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
gamebookId
string
required

Query Parameters

year
required
tenantId
string

Response

OK

Standard v2 API response envelope for single-item responses.

data
null | object[]
meta
object