List sprints visible to the actor

Returns sprints from current team memberships. Personal access token team restrictions are applied before the product query.

GET
/api/v1/workspaces/{workspaceId}/sprints

Returns sprints from current team memberships. Personal access token team restrictions are applied before the product query.

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

Query Parameters

teamId?string

Restrict results to one visible team. Credentials restricted to multiple teams must provide this filter.

Formatuuid
cursor?string

Opaque, signed cursor returned by the preceding page. Do not inspect or modify it.

Length1 <= length <= 8192
limit?integer

Maximum resources to return.

Range1 <= value <= 100
Default50

Response Body

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/sprints"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c",      "teamId": "a4ede8ba-7c0a-4485-8763-cbd9b282fbec",      "objectiveId": "1ac8be30-2b34-409a-be6d-40652b73c978",      "name": "string",      "goal": "string",      "startDate": "2019-08-24T14:15:22Z",      "endDate": "2019-08-24T14:15:22Z",      "automationManaged": true,      "storyCounts": {        "total": 0,        "backlog": 0,        "unstarted": 0,        "started": 0,        "completed": 0,        "cancelled": 0      },      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "hasMore": true,    "nextCursor": "string"  }}