post/exportsWrite operation

Create an asynchronous export

Creates a credential-owned asynchronous CSV export in the owning cell. Resource permissions, sharing filters and a 10,000-row bound are applied again by the export worker.

Required scopes

exports:write

Conditional scopes

contacts:readprojects:readtask-recurrences:readtasks:readtime-entries:read

Request example

curl --request POST \
  --url 'https://api.de.teamgrid.app/v1/exports' \
  --header 'Authorization: Bearer $TEAMGRID_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "createdAtFrom": "2026-07-29T09:00:00.000Z",
    "createdAtTo": "2026-07-29T09:00:00.000Z",
    "fields": [
      "string"
    ],
    "fileName": "string",
    "format": "string",
    "includeArchived": false,
    "maxRows": 1,
    "resourceType": "auditEvents",
    "updatedFrom": "2026-07-29T09:00:00.000Z",
    "updatedUntil": "2026-07-29T09:00:00.000Z"
  }'

const response = await fetch('https://api.de.teamgrid.app/v1/exports', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "createdAtFrom": "2026-07-29T09:00:00.000Z",
  "createdAtTo": "2026-07-29T09:00:00.000Z",
  "fields": [
    "string"
  ],
  "fileName": "string",
  "format": "string",
  "includeArchived": false,
  "maxRows": 1,
  "resourceType": "auditEvents",
  "updatedFrom": "2026-07-29T09:00:00.000Z",
  "updatedUntil": "2026-07-29T09:00:00.000Z"
}),
})

const result = await response.json()

type ApiResponse = unknown

const response = await fetch('https://api.de.teamgrid.app/v1/exports', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "createdAtFrom": "2026-07-29T09:00:00.000Z",
  "createdAtTo": "2026-07-29T09:00:00.000Z",
  "fields": [
    "string"
  ],
  "fileName": "string",
  "format": "string",
  "includeArchived": false,
  "maxRows": 1,
  "resourceType": "auditEvents",
  "updatedFrom": "2026-07-29T09:00:00.000Z",
  "updatedUntil": "2026-07-29T09:00:00.000Z"
}),
})

const result: ApiResponse = await response.json()

teamgrid exports create \
  --data @payload.json \
  --idempotency-key REQUEST_KEY

Example response 2xx

{
  "data": {
    "attributes": {
      "replayed": false
    },
    "id": "string",
    "type": null
  },
  "meta": {
    "requestId": "string"
  }
}

EndpointGerman region

Interactive request builder

Prepare this request

Build locally · nothing is sent

Region

Credential variable

Idempotency-Keyheader · required

JSON request bodyValid 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.

Headers

Idempotency-Keyrequired

string

Unique request key retained for seven days. Within that window, reuse with different data is rejected.

Request body

application/json

createdAtFrom

stringdate-time

ISO 8601 timestamp for created at from.

createdAtTo

stringdate-time

ISO 8601 timestamp for created at to.

fields

array<string>

The fields associated with this export.

fileName

string

Original or user-visible name of the file.

format

string

The format associated with this export.

includeArchived

boolean

Whether include archived applies to this export.

maxRows

integer

The max rows associated with this export.

resourceTyperequired

string

Canonical TeamGrid resource type.

auditEventscontactsprojectstaskRecurrencestaskstimeEntries

updatedFrom

stringdate-time

ISO 8601 timestamp for updated from.

updatedUntil

stringdate-time

ISO 8601 timestamp for updated until.

Responses

201The credential-owned export job was created or replayed.application/json

Response schemaapplication/json

required

ExportCreation

Public API representation of export creation.

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.

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

Documentation feedbackWas this page useful?