get/planned-workRead operation

List planned work in a bounded window

Returns a stable ascending keyset page from the credential cell. The cursor is bound to the workspace and complete filter set. Authorization filtering can produce an empty page with a non-null cursor.

Required scopes

planned-work:read

Request example

curl --request GET \
  --url 'https://api.de.teamgrid.app/v1/planned-work?cursor=CURSOR&limit=50&start=2026-07-29T09%3A00%3A00Z' \
  --header 'Authorization: Bearer $TEAMGRID_API_TOKEN'

const response = await fetch('https://api.de.teamgrid.app/v1/planned-work?cursor=CURSOR&limit=50&start=2026-07-29T09%3A00%3A00Z', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
  },
})

const result = await response.json()

type ApiResponse = unknown

const response = await fetch('https://api.de.teamgrid.app/v1/planned-work?cursor=CURSOR&limit=50&start=2026-07-29T09%3A00%3A00Z', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
  },
})

const result: ApiResponse = await response.json()

teamgrid planned-work list \
  --output json

Example response 2xx

{
  "data": [
    "PlannedWork"
  ],
  "meta": {
    "page": {
      "limit": 1,
      "nextCursor": null
    },
    "requestId": "string"
  }
}

EndpointGerman region

Interactive request builder

Prepare this request

Build locally · nothing is sent

Region

Credential variable

cursorquerylimitquerystartquery · requiredendquery · requiredtaskIdqueryprojectIdqueryuserIdquery

Generated cURL

The builder does not execute requests or persist credentials. Replace the environment-variable placeholder only in your terminal or secret-aware runtime.

Query parameters

cursor

string

Opaque cursor returned in meta.page.nextCursor.

limit

integer

Maximum number of records to return in this page. The response may contain fewer records.

startrequired

string

Inclusive window start. Together with end, limited to 366 days and years 2000–2100.

endrequired

string

Inclusive window end. Together with start, limited to 366 days and years 2000–2100.

taskId

string

Filter by task id.

projectId

string

Filter by project id.

userId

string

Filter by user id.

Responses

200A bounded page of resources visible to the credential, with request metadata and an opaque cursor when another page is available.application/json

Response schemaapplication/json

required

array<PlannedWork>

Public API representation of planned work.

required

object

400The request is invalid.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

401The bearer credential is missing, invalid, expired, or revoked.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

403The credential has insufficient scope.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

409The request conflicts with the current resource state.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

429The credential or source exceeded its rate limit.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

502The cell-local application returned an invalid response.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

503A required cell-local dependency is unavailable.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

Operation IDlistPlannedWorkOpenAPI JSON ↗

Documentation feedbackWas this page useful?