Get a session board

Returns the current AI-generated board content for a session and board spec. The payload field is free-form JSON whose shape depends on the board definition. Requires the torqee:boards:read scope.

GET/api/v1/sessions/{sessionId}/boards/{boardSpecId}

Authorization

AuthorizationOAuth2 access token · headerrequired

OAuth 2.1 authorization code flow with PKCE. Audience must be the connect URL.

Scopes:torqee:boards:read

AuthorizationBearer token · headerrequired

Workspace API key issued from the torqee web app. Pass the torqee_-prefixed key as the bearer token. API keys carry the same read scopes as OAuth tokens.

Path parameters

sessionIdstringrequired

boardSpecIdstringrequired

Responses

200

Current board content for the session and board spec

boardobjectrequired

Show properties

idstringrequired

boardIdstringrequired

versionnumberrequired

statusstringrequired

isCurrentbooleanrequired

sourceRevisionKindstringrequired

createdAtstringrequired

payloadanyrequired

Free-form JSON whose shape depends on the board definition

payloadHashstringrequired

401

Missing or invalid credentials

errorstringrequired

Allowed:unauthorized

403

Membership revoked or insufficient scope

errorstringrequired

Allowed:insufficient_scopeforbidden

404

Session or board content not found, or tenant database could not be resolved

errorstringrequired

Allowed:not_foundworkspace_not_found

500

Unexpected server error

errorstringrequired

Allowed:internal_server_error

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Parameters

sessionIdpath*boardSpecIdpath*

Request

curl -X GET 'https://connect.torqee.app/api/v1/sessions/string/boards/string' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://connect.torqee.app/api/v1/sessions/string/boards/string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://connect.torqee.app/api/v1/sessions/string/boards/string",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "board": {
    "id": "string",
    "boardId": "string",
    "version": 0,
    "status": "string",
    "isCurrent": true,
    "sourceRevisionKind": "string",
    "createdAt": "string",
    "payload": null,
    "payloadHash": "string"
  }
}

{
  "error": "unauthorized"
}

{
  "error": "insufficient_scope"
}

{
  "error": "not_found"
}

{
  "error": "internal_server_error"
}