get/planned-work-operations/{id}Read operation

Get a planned-work replacement operation

Polls a credential-owned, workspace-owned asynchronous replacement operation. Tenant and cell routing internals are never projected.

Required scopes

planned-work:write

Request example

curl --request GET \
  --url 'https://api.de.teamgrid.app/v1/planned-work-operations/ID' \
  --header 'Authorization: Bearer $TEAMGRID_API_TOKEN'

const response = await fetch('https://api.de.teamgrid.app/v1/planned-work-operations/ID', {
  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-operations/ID', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
  },
})

const result: ApiResponse = await response.json()

teamgrid planned-work-operations get \
  ID \
  --output json

Example response 2xx

{
  "data": {
    "attributes": {
      "attempts": 0,
      "createdAt": "2026-07-29T09:00:00.000Z",
      "error": {
        "code": "example",
        "message": "string"
      },
      "finishedAt": "2026-07-29T09:00:00.000Z",
      "plannedEnd": "2026-07-29T09:00:00.000Z",
      "plannedStart": "2026-07-29T09:00:00.000Z",
      "projectId": "example",
      "sourceRevision": "example",
      "state": "failed",
      "targetRevision": "example",
      "taskId": "example",
      "updatedAt": "2026-07-29T09:00:00.000Z"
    },
    "id": "example",
    "type": "string"
  },
  "meta": {
    "requestId": "string"
  }
}

EndpointGerman region

Interactive request builder

Prepare this request

Build locally · nothing is sent

Region

Credential variable

idpath · required

Generated cURL

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

Path parameters

idrequired

string

Stable identifier of the resource in the authenticated workspace.

Responses

200The request to get a planned-work replacement operation succeeded. The response contains the canonical public result and request metadata.application/json

Response schemaapplication/json

required

PlannedWorkOperation

Public API representation of planned work operation.

required

ResponseMeta

Public API representation of meta.

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.

404The tenant-scoped resource does not exist.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 IDgetPlannedWorkOperationOpenAPI JSON ↗

Documentation feedbackWas this page useful?