post/task-recurrences/previewWrite operation

Preview a draft task recurrence

Use this operation to preview a draft task recurrence. The server validates the complete payload and derives workspace ownership from the authenticated credential. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request.

Required scopes

task-recurrences:writetasks:readtasks:write

Request example

curl --request POST \
  --url 'https://api.de.teamgrid.app/v1/task-recurrences/preview' \
  --header 'Authorization: Bearer $TEAMGRID_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "context": null,
    "count": 20,
    "from": "2026-07-29T09:00:00.000Z",
    "policy": {
      "candidates": null,
      "conditions": [
        "TaskRecurrenceCondition"
      ],
      "engineVersion": "string",
      "limits": {
        "maxOccurrences": null,
        "until": null
      },
      "materialization": {
        "catchUp": "all",
        "catchUpLimit": 1,
        "lead": {
          "unit": "minute",
          "value": 0
        },
        "overlap": "allow"
      },
      "schemaVersion": 0,
      "timeBasis": {
        "disambiguation": "compatible",
        "mode": "elapsed",
        "timeZone": "string"
      },
      "transforms": [
        "TaskRecurrenceTransform"
      ]
    },
    "template": {
      "billable": false,
      "contactId": "example",
      "customFieldValues": null,
      "description": "string",
      "descriptionFormat": "markdown-v1",
      "groupId": "example",
      "listId": "example",
      "name": "string",
      "personalListId": "example",
      "plannedTime": 0,
      "projectId": "example",
      "serviceId": "example"
    },
    "until": "2026-07-29T09:00:00.000Z"
  }'

const response = await fetch('https://api.de.teamgrid.app/v1/task-recurrences/preview', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "context": null,
  "count": 20,
  "from": "2026-07-29T09:00:00.000Z",
  "policy": {
    "candidates": null,
    "conditions": [
      "TaskRecurrenceCondition"
    ],
    "engineVersion": "string",
    "limits": {
      "maxOccurrences": null,
      "until": null
    },
    "materialization": {
      "catchUp": "all",
      "catchUpLimit": 1,
      "lead": {
        "unit": "minute",
        "value": 0
      },
      "overlap": "allow"
    },
    "schemaVersion": 0,
    "timeBasis": {
      "disambiguation": "compatible",
      "mode": "elapsed",
      "timeZone": "string"
    },
    "transforms": [
      "TaskRecurrenceTransform"
    ]
  },
  "template": {
    "billable": false,
    "contactId": "example",
    "customFieldValues": null,
    "description": "string",
    "descriptionFormat": "markdown-v1",
    "groupId": "example",
    "listId": "example",
    "name": "string",
    "personalListId": "example",
    "plannedTime": 0,
    "projectId": "example",
    "serviceId": "example"
  },
  "until": "2026-07-29T09:00:00.000Z"
}),
})

const result = await response.json()

type ApiResponse = unknown

const response = await fetch('https://api.de.teamgrid.app/v1/task-recurrences/preview', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "context": null,
  "count": 20,
  "from": "2026-07-29T09:00:00.000Z",
  "policy": {
    "candidates": null,
    "conditions": [
      "TaskRecurrenceCondition"
    ],
    "engineVersion": "string",
    "limits": {
      "maxOccurrences": null,
      "until": null
    },
    "materialization": {
      "catchUp": "all",
      "catchUpLimit": 1,
      "lead": {
        "unit": "minute",
        "value": 0
      },
      "overlap": "allow"
    },
    "schemaVersion": 0,
    "timeBasis": {
      "disambiguation": "compatible",
      "mode": "elapsed",
      "timeZone": "string"
    },
    "transforms": [
      "TaskRecurrenceTransform"
    ]
  },
  "template": {
    "billable": false,
    "contactId": "example",
    "customFieldValues": null,
    "description": "string",
    "descriptionFormat": "markdown-v1",
    "groupId": "example",
    "listId": "example",
    "name": "string",
    "personalListId": "example",
    "plannedTime": 0,
    "projectId": "example",
    "serviceId": "example"
  },
  "until": "2026-07-29T09:00:00.000Z"
}),
})

const result: ApiResponse = await response.json()

teamgrid task-recurrences create \
  --data @payload.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

JSON request body

{
  "context": null,
  "count": 20,
  "from": "2026-07-29T09:00:00.000Z",
  "policy": {
    "candidates": null,
    "conditions": [
      "TaskRecurrenceCondition"
    ],
    "engineVersion": "string",
    "limits": {
      "maxOccurrences": null,
      "until": null
    },
    "materialization": {
      "catchUp": "all",
      "catchUpLimit": 1,
      "lead": {
        "unit": "minute",
        "value": 0
      },
      "overlap": "allow"
    },
    "schemaVersion": 0,
    "timeBasis": {
      "disambiguation": "compatible",
      "mode": "elapsed",
      "timeZone": "string"
    },
    "transforms": [
      "TaskRecurrenceTransform"
    ]
  },
  "template": {
    "billable": false,
    "contactId": "example",
    "customFieldValues": null,
    "description": "string",
    "descriptionFormat": "markdown-v1",
    "groupId": "example",
    "listId": "example",
    "name": "string",
    "personalListId": "example",
    "plannedTime": 0,
    "projectId": "example",
    "serviceId": "example"
  },
  "until": "2026-07-29T09:00:00.000Z"
}

Valid JSON

Generated cURL

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

Request body

application/json

context

object

The context associated with this task recurrence preview.

count

integer

The count associated with this task recurrence preview.

Default: 20

from

stringdate-time

ISO 8601 timestamp for from.

required

TaskRecurrencePolicyInput

The policy associated with this task recurrence preview.

TaskRecurrenceTemplateInput

The template associated with this task recurrence preview.

until

stringdate-time

ISO 8601 timestamp for until.

Responses

200A deterministic, bounded draft preview with no persisted side effects.application/json

Response schemaapplication/json

required

TaskRecurrencePreview

Public API representation of task recurrence preview.

required

ResponseMeta

Public API representation of meta.

202An encrypted, recoverable asynchronous preview operation.application/json

Response schemaapplication/json

required

TaskRecurrenceOperation

Public API representation of task recurrence 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.

413The policy exceeds the synchronous preview complexity budget.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 IDpreviewTaskRecurrenceOpenAPI JSON ↗

Documentation feedbackWas this page useful?