Sign in
sessions

Get session by workspace

Returns session information for a specific workspace. Accepts workspace ID (UUID) or path. Use ?full=true for complete session data including messages. Supports conditional requests via If-None-Match header for efficient polling.

get/v1/sessions/workspace/{workspace}

Path parameters

workspacestring required

Workspace ID (UUID) or directory path

Query parameters

fullboolean

Include full session data with messages and user prompts

Headers

If-None-Matchstring

ETag from previous request

Response

Basic session info when full=false

claude_session_uuidstring

Unique identifier for the Claude session

ended_atstring

When the session ended (if not active)

resumed_atstring

When the session was resumed (if applicable)

started_atstring

When the session was initially started

titlestring

Title of the session

Example response

{
  "claude_session_uuid": "abc123-def456-ghi789",
  "ended_at": "2024-01-15T18:30:00Z",
  "resumed_at": "2024-01-15T16:00:00Z",
  "started_at": "2024-01-15T14:30:00Z",
  "title": "Updating README.md"
}

Changes

Changed in 2 of the 50 revisions of this API.13

  • 648598c377f92See the full diff
    • ○

      added the new optional header request parameter If-None-Match

      new-optional-request-parameter

    • ○

      added the non-success response with the status 304

      response-non-success-status-added

  • 21270d5158bd11See the full diff
    • ●

      deleted the header request parameter If-None-Match

      request-parameter-removed

    • ○

      removed the non-success response with the status 304

      response-non-success-status-removed