Tasks

Get a task

Returns the detail of a task by its identifier.

GET

/api/v1/tasks/{taskId}

curl https://app.filmo.io/api/v1/tasks/task_8f2a1c \
  --header "Authorization: Bearer $FILMO_API_KEY"

Node.jsfetch('https://app.filmo.io/api/v1/tasks/task_8f2a1c', { headers: { Authorization: 'Bearer YOUR_FILMO_API_KEY' } })Pythonimport requests requests.get( "https://app.filmo.io/api/v1/tasks/task_8f2a1c", headers={ "Authorization": "Bearer YOUR_FILMO_API_KEY" } )

{
  "data": {
    "id": "task_9f3a2b",
    "title": "Example title",
    "description": "Example text.",
    "startDate": "2026-09-01T08:00:00.000Z",
    "endDate": "2026-09-01T08:00:00.000Z",
    "isAllDay": true,
    "isCompleted": true,
    "isRecurring": true,
    "recurringGroupId": "recurring_group_9f3a2b",
    "recurrencePattern": {
      "frequency": "daily",
      "interval": 1,
      "endAfterOccurrences": 1,
      "endDate": "2026-09-01T08:00:00.000Z"
    },
    "type": "Example type",
    "assignedStaffIds": [
      "assigned_staff_9f3a2b"
    ],
    "projectId": "project_9f3a2b",
    "relatedDocumentId": "related_document_9f3a2b",
    "relatedDocumentType": "Example related document type",
    "appearance": {
      "color": "Example color",
      "variant": "primary"
    },
    "createdAt": "2026-09-01T08:00:00.000Z",
    "updatedAt": "2026-09-01T08:00:00.000Z"
  }
}

// No body.

{
  "type": "https://docs.filmo.io/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "code": "unauthorized",
  "detail": "Missing Authorization header: Bearer <api key>",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/insufficient_scope",
  "title": "Insufficient scope",
  "status": 403,
  "code": "insufficient_scope",
  "detail": "The API key does not have the required scope (orders:write)",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "requiredScope": "tasks:read"
}

{
  "type": "https://docs.filmo.io/errors/not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "Resource not found",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/rate_limited",
  "title": "Rate limit exceeded",
  "status": 429,
  "code": "rate_limited",
  "detail": "Rate limit exceeded: retry in 30 seconds",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "retryAfter": 30
}

{
  "type": "https://docs.filmo.io/errors/internal_error",
  "title": "Internal error",
  "status": 500,
  "code": "internal_error",
  "detail": "Internal error",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

Generated from the schema

Authorizations

Bearer API key with the scope below. tasks:read

Headers

If-None-Matchstring

Conditional read: the ETag of the copy you already have. If the resource has not changed, the response is 304 with no body.

Example:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""

Path parameters

taskIdstringRequired

Task identifier.

Limits: min length 1

Response

application/json

Successful response.

Response schema: TaskDto

Envelope: TaskResponse. meta.warnings is present only when the operation is deprecated.

Headers: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag

dataobject

The task, as returned by the API.

Show child attributes

data.idstring

Unique task identifier.

data.titlestring

Task title.

data.descriptionstring | null

Task description or notes; null if it has none.

data.startDatestring<date-time>

Start date and time in ISO 8601 with offset.

data.endDatestring<date-time> | null

End date and time in ISO 8601 with offset; null if it has no defined end.

data.isAllDayboolean

Whether the task is all-day.

data.isCompletedboolean

Whether the task is completed.

data.isRecurringboolean

Whether the task is part of a recurring series.

data.recurringGroupIdstring | null

Identifier of the recurrence group it belongs to; null if it is not recurring.

data.recurrencePatternobject | null

Recurrence pattern of the task; null if it is not recurring.

Show child attributes

data.recurrencePattern.frequencystring

Recurrence frequency: daily, weekly, monthly or yearly.

Available options: daily, weekly, monthly, yearly

data.recurrencePattern.intervalinteger

Interval between repetitions according to the frequency (e.g. 2 with weekly = every two weeks).

data.recurrencePattern.endAfterOccurrencesinteger | null

Number of repetitions after which the recurrence ends; null if it does not end by number of occurrences.

data.recurrencePattern.endDatestring<date-time> | null

Date on which the recurrence ends, in ISO 8601 with offset; null if it does not end by date.

data.typestring

Task type (identifier of the type).

data.assignedStaffIdsstring[]

Identifiers of the staff assigned to the task.

data.projectIdstring | null

Identifier of the linked project; null if the task is not linked.

data.relatedDocumentIdstring | null

Identifier of the related document; null if it has none.

data.relatedDocumentTypestring | null

Type of the related document (contact, order, invoice, quote, project, etc.); null if it has none.

data.appearanceobject

Appearance of the task in the schedule (color and variant).

Show child attributes

data.appearance.colorstring

Task color in the schedule (hexadecimal code).

data.appearance.variantstring

Visual variant of the task: primary, secondary, destructive or default.

Available options: primary, secondary, destructive, default

data.createdAtstring<date-time>

Creation date in ISO 8601 with offset.

data.updatedAtstring<date-time>

Last update date in ISO 8601 with offset.

metaobject

Additional information about the response.

Show child attributes

meta.warningsobject[]

Lifecycle warnings; present only when the operation is deprecated.

Show child attributes

meta.warnings.codestring

Stable warning code.

Available options: deprecated

meta.warnings.messagestring

For people: what is deprecated, until when, and what to use.

meta.warnings.sunsetstring

Day (YYYY-MM-DD) the operation stops being served.

meta.warnings.replacementstring | null

operationId of the operation to use instead, or null if there is none.

meta.warnings.linkstring

Where the deprecation is documented (the changelog).

Errors

Status	Codes	Meaning
404	`not_found`	It does not exist or is outside the scope of the API key.

401, 403, 429, 500 can be returned by any operation. Errors

Deprecation

This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date. Versioning policy

Operations
Task
The task, as returned by the API.

Was this page helpful?

Request examples

Authorizations

Headers

Path parameters

Response

Errors

Deprecation

Related

Related pages

Task