get/task-recurrences/{id}/previewRead operation

Preview a stored task recurrence

Use this operation to preview a stored task recurrence. It returns the resource only when it belongs to the authenticated workspace and is visible to the credential. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request.

Required scopes

task-recurrences:readtasks:read

Request example

curl --request GET \
  --url 'https://api.de.teamgrid.app/v1/task-recurrences/ID/preview?from=2026-07-29T09%3A00%3A00Z&until=2026-07-29T09%3A00%3A00Z&count=20' \
  --header 'Authorization: Bearer $TEAMGRID_API_TOKEN'

const response = await fetch('https://api.de.teamgrid.app/v1/task-recurrences/ID/preview?from=2026-07-29T09%3A00%3A00Z&until=2026-07-29T09%3A00%3A00Z&count=20', {
  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/task-recurrences/ID/preview?from=2026-07-29T09%3A00%3A00Z&until=2026-07-29T09%3A00%3A00Z&count=20', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
  },
})

const result: ApiResponse = await response.json()

teamgrid task-recurrences preview \
  ID \
  --output json

Example response 2xx

{
  "data": {
    "attributes": {
      "costClass": "low",
      "definitionHash": "example",
      "occurrences": [
        {
          "cardDates": {
            "dueDate": null,
            "plannedEnd": null,
            "plannedStart": null
          },
          "occurrenceKey": "string",
          "placeholderToken": null,
          "provenance": [
            null
          ],
          "scheduledFor": "2026-07-29T09:00:00.000Z",
          "scheduledForLocal": "string",
          "timeZone": "string"
        }
      ],
      "summary": null
    },
    "id": "string",
    "type": null
  },
  "meta": {
    "requestId": "string"
  }
}

EndpointGerman region

Interactive request builder

Prepare this request

Build locally · nothing is sent

Region

Credential variable

idpath · requiredfromqueryuntilquerycountquery

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.

Query parameters

from

string

Preview lower time boundary.

until

string

Preview upper time boundary.

count

integer

Maximum preview occurrences.

Responses

200The authorized recurrence resource.application/json

Response schemaapplication/json

required

TaskRecurrencePreview

Public API representation of task recurrence preview.

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 IDpreviewStoredTaskRecurrenceOpenAPI JSON ↗

Documentation feedbackWas this page useful?