Factuarea APIDevelopers

Cercar tasques

Cerca les tasques de la teva empresa en tots els projectes.

  • Filtres: q (text lliure; un valor amb forma de clau de tasca com DEV-12 també coincideix amb aquesta clau), project_id, status (planned, active, archived), column_id, priority, assignee_id (l'UUID d'un membre o me), label_id, due_before, due_after i completed.
  • sort accepta created_at, updated_at, due_on, priority o number, amb el prefix - per a ordre descendent (per defecte -created_at); els empats es desfan per id, així que l'ordre és estable.
  • Amb paginació per cursor: passa el next_cursor d'una pàgina com a starting_after per obtenir la següent; has_more indica si n'hi ha més.
GET
/tasks
AuthorizationBearer <token>

A: header

Paràmetres de consulta

q?|

Text lliure que es compara amb el títol i la descripció de la tasca. Un valor amb forma de clau de tasca (DEV-12) també troba aquesta tasca per la seva clau o per un àlies anterior. Màxim 512 caràcters.

Longitudlength <= 512
project_id?string

UUID d'un projecte de la teva empresa: només es retornen les seves tasques.

Formatuuid
status?string

Estat al tauler: planned (backlog), active (en una columna del tauler) o archived.

Valor a"planned" | "active" | "archived"
column_id?string

UUID d'una columna del tauler: només es retornen les tasques d'aquesta columna.

Formatuuid
priority?string

Prioritat de la tasca: none, low, medium, high o urgent.

Valor a"none" | "low" | "medium" | "high" | "urgent"
assignee_id?string

UUID del membre assignat, o me per al membre titular de l'API key.

Coincidència^(?:me|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$
label_id?string

UUID d'una etiqueta de tasca: només es retornen les tasques que porten aquesta etiqueta.

Formatuuid
due_before?string

Només tasques amb venciment en aquesta data o anterior (YYYY-MM-DD).

Formatdate
due_after?string

Només tasques amb venciment en aquesta data o posterior (YYYY-MM-DD).

Formatdate
completed?boolean

true retorna només les tasques completades; false, només les obertes. Omet-lo per retornar-les totes dues.

sort?string

Ordre: un camp per a ascendent o el prefix - per a descendent. Camps permesos: created_at, updated_at, due_on, priority, number. Per defecte -created_at; els empats es desfan per id, així que la paginació es manté estable.

Valor a"created_at" | "-created_at" | "updated_at" | "-updated_at" | "due_on" | "-due_on" | "priority" | "-priority" | "number" | "-number"
limit?integer

Nombre de tasques a retornar. Enter entre 1 i 100. Per defecte 25.

Rang1 <= value <= 100
starting_after?string

Cursor de paginació cap endavant: l'id de l'última tasca de la pàgina anterior (el next_cursor que vas rebre). Un id que no és una tasca de la teva empresa retorna 422 invalid_param_value.

Formatuuid

Headers

Factuarea-Version?string

Fixa la versió de l'API (YYYY-MM-DD, versionat per data estil Stripe) per a aquesta petició; omet-lo per usar la versió fixada de la clau, o l'última si no n'hi ha cap. Versió no suportada → 400 unsupported_api_version; mal formada → 400 parameter_invalid_format. La versió efectiva es reflecteix a la capçalera de resposta Factuarea-Version. Consulta la guia de Versioning.

Formatdate
X-Active-Profile?string

Opera en nom d'una empresa filla (API key mestra de gestoria): passa el seu id públic (UUID v7) i la petició s'executa contra les dades d'aquella filla sense canviar l'scope, el tier ni l'environment de la clau (omet-lo per usar la pròpia empresa de la clau). UUID no vàlid → 400 parameter_invalid_uuid; id desconegut o no propi → 404 profile_not_found. Consulta la guia d'Acting on behalf.

Formatuuid

Cos de la resposta

application/json

application/json

application/json

application/json

application/json

application/json

application/json