Factuarea APIDevelopers

List agenda items

Return a combined agenda between from and to (at most 93 days, both included): due tasks and, from other modules, invoice and purchase invoice due dates, quote and pro forma expiries, recurring invoice runs, tax deadlines, absences and holidays.

  • sources chooses the layers.
  • Every layer also needs the read scope of its own resource and its module (for example invoices:read for invoice due dates, absences:read for absences); layers the key cannot read are left out without an error, and sources in the response lists the layers actually served.
  • assignee_id (me or a member id) filters the task layer.
  • The whole window is returned in one page.
GET
/agenda
AuthorizationBearer <token>

In: header

Query Parameters

from*string

First day of the window (YYYY-MM-DD, included). Required.

Formatdate
to*string

Last day of the window (YYYY-MM-DD, included). Required. The window spans at most 93 days: a longer or inverted window returns 400 parameter_invalid_range on to.

Formatdate
sources?string

Comma-separated layers to include: tasks, invoice_due, purchase_invoice_due, quote_expiry, proforma_expiry, recurring_invoice_run, fiscal_deadline, absence, holiday. Omit it to include every layer; an empty value includes none. Each layer also requires the read scope of its resource (for example invoices:read for invoice_due) and its module: layers the key cannot read are left out without an error, and the sources of the response lists only the layers actually served. An unknown layer returns 400 parameter_invalid_enum.

assignee_id?|

Only filters the tasks layer: me for the member who owns the API key, or the UUID of a member of your company. Any other value returns 422 invalid_param_value.

Headers

Factuarea-Version?string

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Formatdate
X-Active-Profile?string

Operate on behalf of a child company (gestoría master key): pass its public id (UUID v7) and the request runs against that child's data without changing the key's scope, tier or environment (omit to use the key's own company). Invalid UUID → 400 parameter_invalid_uuid; unknown or non-owned id → 404 profile_not_found. See the Acting on behalf guide.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json