Tareas

Listar tareas

Devuelve las tareas y los eventos de la agenda, paginados por cursor.

GET
/api/v1/tasks

Ejemplos de petición

curl https://app.filmo.io/api/v1/tasks \
  --header "Authorization: Bearer $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
  }
}

Generado a partir del esquema

Aislamiento estricto por suscripción.

Autorizaciones

Clave de API como Bearer, con el permiso de abajo. tasks:read

Parámetros de consulta

limitintegerpredeterminado:50

Tamaño de página (1-500). Por defecto es 50.

Límites: mín. 1, máx. 500

cursorstring

Cursor opaco de la página que se devuelve. Pasa el valor de pagination.nextCursor de la respuesta anterior; trátalo como opaco.

Límites: longitud máx. 200

createdOnstring

La fecha de creación del recurso cae en esta fecha. Una fecha sin hora (YYYY-MM-DD, interpretada en la zona horaria del negocio) o un instante ISO 8601 con desplazamiento.

Límites: patrón ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

createdAfterstring

La fecha de creación del recurso es posterior a esta fecha. Una fecha sin hora (YYYY-MM-DD, interpretada en la zona horaria del negocio) o un instante ISO 8601 con desplazamiento.

Límites: patrón ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

createdBeforestring

La fecha de creación del recurso es anterior a esta fecha. Una fecha sin hora (YYYY-MM-DD, interpretada en la zona horaria del negocio) o un instante ISO 8601 con desplazamiento.

Límites: patrón ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

createdFromstring

La fecha de creación del recurso es igual o posterior a esta fecha. Una fecha sin hora (YYYY-MM-DD, interpretada en la zona horaria del negocio) o un instante ISO 8601 con desplazamiento.

Límites: patrón ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

createdTostring

La fecha de creación del recurso es igual o anterior a esta fecha. Una fecha sin hora (YYYY-MM-DD, interpretada en la zona horaria del negocio) o un instante ISO 8601 con desplazamiento.

Límites: patrón ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

updatedOnstring

La fecha de última actualización del recurso cae en esta fecha. Una fecha sin hora (YYYY-MM-DD, interpretada en la zona horaria del negocio) o un instante ISO 8601 con desplazamiento.

Límites: patrón ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

updatedAfterstring

La fecha de última actualización del recurso es posterior a esta fecha. Una fecha sin hora (YYYY-MM-DD, interpretada en la zona horaria del negocio) o un instante ISO 8601 con desplazamiento.

Límites: patrón ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

updatedBeforestring

La fecha de última actualización del recurso es anterior a esta fecha. Una fecha sin hora (YYYY-MM-DD, interpretada en la zona horaria del negocio) o un instante ISO 8601 con desplazamiento.

Límites: patrón ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

updatedFromstring

La fecha de última actualización del recurso es igual o posterior a esta fecha. Una fecha sin hora (YYYY-MM-DD, interpretada en la zona horaria del negocio) o un instante ISO 8601 con desplazamiento.

Límites: patrón ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

updatedTostring

La fecha de última actualización del recurso es igual o anterior a esta fecha. Una fecha sin hora (YYYY-MM-DD, interpretada en la zona horaria del negocio) o un instante ISO 8601 con desplazamiento.

Límites: patrón ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

sortstring

Orden: hasta 3 campos separados por comas, cada uno con un "-" inicial para descendente (p. ej. "-updatedAt,name"). Campos ordenables: createdAt, updatedAt, startDate, endDate, title, isCompleted, type. Por defecto, "-createdAt". Los empates se resuelven por id, así que el orden es estable entre páginas, y un cursor queda ligado al orden con el que se emitió.

Límites: longitud máx. 200

fromstring<date-time>

Inicio de la ventana de solapamiento (ISO 8601 con desplazamiento): devuelve las tareas que se solapan con [from, to] (cuenta una tarea que empieza antes y termina dentro).

tostring<date-time>

Fin de la ventana de solapamiento (ISO 8601 con desplazamiento): devuelve las tareas que se solapan con [from, to].

assignedStaffIdstring

Filtra por miembro del personal asignado (el mismo identificador que expone assignedStaffIds en el DTO).

Límites: longitud mín. 1, longitud máx. 100

assignedStaffIdsstring[]

Filtra por assignedStaffId, como lista: repite el parámetro o separa los valores con comas. Acepta hasta 50 valores y devuelve lo que coincida con cualquiera de ellos.

Límites: mín. 1 elementos, máx. 50 elementos, cada uno: longitud mín. 1, cada uno: longitud máx. 100

isCompletedboolean

Filtra por finalización: "true" solo las tareas completadas, "false" solo las tareas pendientes. Omítelo para no aplicar ningún filtro.

typestring

Filtra por tipo de tarea: su identificador (tipos del sistema: default, delivery, return, temporaryStock; tipos personalizados: su id) o su nombre, comparado sin distinguir mayúsculas ni acentos. Un nombre que no coincide con ningún tipo devuelve una lista vacía; uno que coincide con varios se rechaza con 400.

Límites: longitud mín. 1, longitud máx. 100

typesstring[]

Filtra por type, como lista: repite el parámetro o separa los valores con comas. Acepta hasta 50 valores y devuelve lo que coincida con cualquiera de ellos.

Límites: mín. 1 elementos, máx. 50 elementos, cada uno: longitud mín. 1, cada uno: longitud máx. 100

relatedDocumentIdstring

Filtra por identificador del documento relacionado con la tarea.

Límites: longitud mín. 1, longitud máx. 100

relatedDocumentIdsstring[]

Filtra por relatedDocumentId, como lista: repite el parámetro o separa los valores con comas. Acepta hasta 50 valores y devuelve lo que coincida con cualquiera de ellos.

Límites: mín. 1 elementos, máx. 50 elementos, cada uno: longitud mín. 1, cada uno: longitud máx. 100

dueOnstring

La fecha límite de la tarea (su fin o, si no tiene, su inicio) cae en esta fecha. Una fecha sin hora (YYYY-MM-DD, interpretada en la zona horaria del negocio) o un instante ISO 8601 con desplazamiento.

Límites: patrón ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

dueAfterstring

La fecha límite de la tarea (su fin o, si no tiene, su inicio) es posterior a esta fecha. Una fecha sin hora (YYYY-MM-DD, interpretada en la zona horaria del negocio) o un instante ISO 8601 con desplazamiento.

Límites: patrón ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

dueBeforestring

La fecha límite de la tarea (su fin o, si no tiene, su inicio) es anterior a esta fecha. Una fecha sin hora (YYYY-MM-DD, interpretada en la zona horaria del negocio) o un instante ISO 8601 con desplazamiento.

Límites: patrón ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

dueFromstring

La fecha límite de la tarea (su fin o, si no tiene, su inicio) es igual o posterior a esta fecha. Una fecha sin hora (YYYY-MM-DD, interpretada en la zona horaria del negocio) o un instante ISO 8601 con desplazamiento.

Límites: patrón ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

dueTostring

La fecha límite de la tarea (su fin o, si no tiene, su inicio) es igual o anterior a esta fecha. Una fecha sin hora (YYYY-MM-DD, interpretada en la zona horaria del negocio) o un instante ISO 8601 con desplazamiento.

Límites: patrón ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}(:?\d{2})?))?$

includeTotalbooleanpredeterminado:false

Ponlo en true para incluir pagination.total, el número de resultados que coinciden con los filtros en todas las páginas. Desactivado por defecto.

Respuesta

application/json

Respuesta correcta.

Esquema de la respuesta: TaskDto

Sobre: TaskList. meta.warnings solo aparece cuando la operación está obsoleta.

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

dataobject[]

Mostrar atributos hijos
data.idstring

Identificador único de la tarea.

data.titlestring

Título de la tarea.

data.descriptionstring | null

Descripción o notas de la tarea; null si no tiene.

data.startDatestring<date-time>

Fecha y hora de inicio en ISO 8601 con desplazamiento.

data.endDatestring<date-time> | null

Fecha y hora de fin en ISO 8601 con desplazamiento; null si no tiene un fin definido.

data.isAllDayboolean

Si la tarea dura todo el día.

data.isCompletedboolean

Si la tarea está completada.

data.isRecurringboolean

Si la tarea forma parte de una serie recurrente.

data.recurringGroupIdstring | null

Identificador del grupo de recurrencia al que pertenece; null si no es recurrente.

data.recurrencePatternobject | null

Patrón de recurrencia de la tarea; null si no es recurrente.

Mostrar atributos hijos
data.recurrencePattern.frequencystring

Frecuencia de recurrencia: daily, weekly, monthly o yearly.

Opciones disponibles: daily, weekly, monthly, yearly

data.recurrencePattern.intervalinteger

Intervalo entre repeticiones según la frecuencia (p. ej. 2 con weekly = cada dos semanas).

data.recurrencePattern.endAfterOccurrencesinteger | null

Número de repeticiones tras las cuales termina la recurrencia; null si no termina por número de ocurrencias.

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

Fecha en que termina la recurrencia, en ISO 8601 con desplazamiento; null si no termina por fecha.

data.typestring

Tipo de tarea (identificador del tipo).

data.assignedStaffIdsstring[]

Identificadores del personal asignado a la tarea.

data.projectIdstring | null

Identificador del proyecto vinculado; null si la tarea no está vinculada.

data.relatedDocumentIdstring | null

Identificador del documento relacionado; null si no tiene.

data.relatedDocumentTypestring | null

Tipo del documento relacionado (contacto, pedido, factura, presupuesto, proyecto, etc.); null si no tiene.

data.appearanceobject

Aspecto de la tarea en la agenda (color y variante).

Mostrar atributos hijos
data.appearance.colorstring

Color de la tarea en la agenda (código hexadecimal).

data.appearance.variantstring

Variante visual de la tarea: primary, secondary, destructive o default.

Opciones disponibles: primary, secondary, destructive, default

data.createdAtstring<date-time>

Fecha de creación en ISO 8601 con desplazamiento.

data.updatedAtstring<date-time>

Fecha de la última actualización en ISO 8601 con desplazamiento.

paginationobject

Metadatos de paginación por cursor opaco.

Mostrar atributos hijos
pagination.nextCursorstring | null

Cursor opaco de la página siguiente; null cuando no hay más resultados. Pásalo como cursor en la siguiente petición.

pagination.hasMoreboolean

Si existen más resultados después de esta página.

pagination.totalinteger

Número de resultados que coinciden con los filtros en todas las páginas. Solo aparece cuando la petición establece includeTotal=true.

Límites: mín. 0

metaobject

Información adicional sobre la respuesta.

Mostrar atributos hijos
meta.warningsobject[]

Avisos del ciclo de vida; solo aparecen cuando la operación está obsoleta.

Mostrar atributos hijos
meta.warnings.codestring

Código de aviso estable.

Opciones disponibles: deprecated

meta.warnings.messagestring

Para personas: qué está obsoleto, hasta cuándo y qué usar.

meta.warnings.sunsetstring

Día (YYYY-MM-DD) en que la operación deja de estar disponible.

meta.warnings.replacementstring | null

operationId de la operación que hay que usar en su lugar, o null si no hay ninguna.

Errores

EstadoCódigosSignificado
400validation_errorConsulta o cuerpo mal formados. errors[] enumera cada campo erróneo con su código estable.

401, 403, 429, 500 los puede devolver cualquier operación. Errores

Obsolescencia

Esta operación no está obsoleta. Las obsolescencias se anuncian con la cabecera Deprecation y una fecha de retirada. Política de versiones

  • Operaciones

    Tarea

    La tarea, tal como la devuelve la API.