Get a session

Returns session metadata without transcript segments. userId and userDisplayName identify the user who recorded the session. Requires the torqee:sessions:read scope.

GET/api/v1/sessions/{id}

Authorization

AuthorizationOAuth2 access token · headerrequired

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

Scopes:torqee:sessions: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

idstringrequired

Responses

200

Session metadata

sessionobjectrequired

Show properties

idstringrequired

userIdstringrequired

userDisplayNamestring | nullrequired

labelstring | nullrequired

memostring | nullrequired

statusstringrequired

startedAtstring | nullrequired

endedAtstring | nullrequired

createdAtstringrequired

updatedAtstringrequired

401

Missing or invalid credentials

errorstringrequired

Allowed:unauthorized

403

Membership revoked or insufficient scope

errorstringrequired

Allowed:insufficient_scopeforbidden

404

Session 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

idpath*

Request

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

const response = await fetch("https://connect.torqee.app/api/v1/sessions/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",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "session": {
    "id": "string",
    "userId": "string",
    "userDisplayName": "string",
    "label": "string",
    "memo": "string",
    "status": "string",
    "startedAt": "string",
    "endedAt": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "error": "unauthorized"
}

{
  "error": "insufficient_scope"
}

{
  "error": "not_found"
}

{
  "error": "internal_server_error"
}