Sign upLogin
DocumentationAPI Reference
API referenceStories

Get one visible story

Personal access tokens are supported in this preview. Current workspace and team membership remain authoritative.

GET
/api/v1/workspaces/{workspaceId}/stories/{storyId}

Personal access tokens are supported in this preview. Current workspace and team membership remain authoritative.

Authorization

machineBearer
AuthorizationBearer <token>

Personal access tokens and supported service-account keys are accepted only in the Authorization header and never in URLs. Each operation documents which principal types it authorizes.

In: header

Path Parameters

workspaceId*string

Workspace UUID. It must match the workspace bound to the credential.

Formatuuid
storyId*string
Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/stories/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c",    "teamId": "a4ede8ba-7c0a-4485-8763-cbd9b282fbec",    "sequenceId": 1,    "reference": "string",    "title": "string",    "description": "string",    "statusId": "e900225c-0629-4e96-be6e-86a17a309645",    "assigneeId": "665a9750-71bd-4b96-bacd-9efa4ae022dd",    "reporterId": "997c436a-2349-4904-8879-2f8ba4e8669d",    "sprintId": "341f3342-3ca6-4e1f-b518-9f1e0638eb92",    "objectiveId": "1ac8be30-2b34-409a-be6d-40652b73c978",    "keyResultId": "2547c01d-16e9-4b8e-b627-2c8626eca66a",    "parentId": "70850378-7d3c-4f45-91b7-942d4dfbbd43",    "priority": "string",    "estimateValue": 0,    "estimateLabel": "string",    "estimatedDurationMinutes": 0,    "minimumFocusBlockMinutes": 0,    "autoSchedulingEnabled": true,    "autoSchedulingLocked": true,    "autoSchedulingStatus": "string",    "labels": [      "c11281e2-8355-47a6-9304-21c12cdb76a7"    ],    "startDate": "2019-08-24T14:15:22Z",    "endDate": "2019-08-24T14:15:22Z",    "completedAt": "2019-08-24T14:15:22Z",    "archivedAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}

Create a story POST

Creates one story with a personal access token or supported service-account key. The Idempotency-Key is required; an exact retry returns the original story, while reuse with different JSON bytes is rejected.

List comments on one visible story GET

Returns comments only after the personal access token's user can currently read the owning story and team. Both comments:read and stories:read are required.