Tasks

List tasks

Returns the tasks and schedule events, cursor-paginated.

GET

/api/v1/tasks

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

Node.jsfetch('https://app.filmo.io/api/v1/tasks', { headers: { Authorization: 'Bearer YOUR_FILMO_API_KEY' } })Pythonimport requests requests.get("https://app.filmo.io/api/v1/tasks", 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"
    }
  ],
  "pagination": {
    "nextCursor": "eyJvIjoyMH0",
    "hasMore": true,
    "total": 1
  }
}

{
  "type": "https://docs.filmo.io/errors/validation_error",
  "title": "Validation error",
  "status": 400,
  "code": "validation_error",
  "detail": "2 validation errors",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "errors": [
    {
      "path": "name",
      "code": "too_small",
      "message": "Must be at least 1 characters long"
    },
    {
      "path": "contactType",
      "code": "invalid_value",
      "message": "Value not allowed; expected company, person"
    }
  ]
}

{
  "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/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

Strict per-subscription tenancy.

Authorizations

Bearer API key with the scope below. tasks:read

Query parameters

limitintegerdefault:50

Page size (1-500). Defaults to 50.

Limits: min 1, max 500

cursorstring

Opaque cursor of the page to return. Pass the value of pagination.nextCursor from the previous response; treat it as opaque.

Limits: max length 200

createdOnstring

The creation date of the resource falls on this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

createdAfterstring

The creation date of the resource is after this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

createdBeforestring

The creation date of the resource is before this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

createdFromstring

The creation date of the resource is on or after this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

createdTostring

The creation date of the resource is on or before this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

updatedOnstring

The last update date of the resource falls on this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

updatedAfterstring

The last update date of the resource is after this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

updatedBeforestring

The last update date of the resource is before this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

updatedFromstring

The last update date of the resource is on or after this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

updatedTostring

The last update date of the resource is on or before this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

sortstring

Sort order: up to 3 comma-separated fields, each with a leading "-" for descending (e.g. "-updatedAt,name"). Sortable fields: createdAt, updatedAt, startDate, endDate, title, isCompleted, type. Defaults to "-createdAt". Ties are broken by id, so the order is stable across pages, and a cursor is bound to the sort it was issued with.

Limits: max length 200

fromstring<date-time>

Start of the overlap window (ISO 8601 with offset): returns tasks that overlap [from, to] (a task that starts before and ends within counts).

tostring<date-time>

End of the overlap window (ISO 8601 with offset): returns tasks that overlap [from, to].

assignedStaffIdstring

Filter by assigned staff member (the same identifier that assignedStaffIds exposes in the DTO).

Limits: min length 1, max length 100

assignedStaffIdsstring[]

Filter by assignedStaffId, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.

Limits: min 1 items, max 50 items, each min length 1, each max length 100

isCompletedboolean

Filter by completion: "true" only completed tasks, "false" only pending tasks. Omit it to apply no filter.

typestring

Filter by task type: its identifier (system types: default, delivery, return, temporaryStock; custom types: their id) or its name, matched ignoring case and accents. A name that matches no type yields an empty list; one that matches several is rejected with 400.

Limits: min length 1, max length 100

typesstring[]

Filter by type, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.

Limits: min 1 items, max 50 items, each min length 1, each max length 100

relatedDocumentIdstring

Filter by identifier of the document related to the task.

Limits: min length 1, max length 100

relatedDocumentIdsstring[]

Filter by relatedDocumentId, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.

Limits: min 1 items, max 50 items, each min length 1, each max length 100

dueOnstring

The task due date (its end or, if it has none, its start) falls on this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

dueAfterstring

The task due date (its end or, if it has none, its start) is after this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

dueBeforestring

The task due date (its end or, if it has none, its start) is before this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

dueFromstring

The task due date (its end or, if it has none, its start) is on or after this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

dueTostring

The task due date (its end or, if it has none, its start) is on or before this date. A bare day (YYYY-MM-DD, read in the business timezone) or an ISO 8601 instant with offset.

Limits: pattern ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

includeTotalbooleandefault:false

Set it to true to include pagination.total, the number of results that match the filters across all pages. Off by default.

Response

application/json

Successful response.

Response schema: TaskDto

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

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

dataobject[]

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.

paginationobject

Opaque-cursor pagination metadata.

Show child attributes

pagination.nextCursorstring | null

Opaque cursor of the next page; null when there are no more results. Pass it as cursor in the next request.

pagination.hasMoreboolean

Whether more results exist beyond this page.

pagination.totalinteger

Number of results matching the filters across all pages. Present only when the request sets includeTotal=true.

Limits: min 0

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
400	`validation_error`	Malformed query or body. `errors[]` lists every offending field with its stable code.

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

Query parameters

Response

Errors

Deprecation

Related

Related pages

Task