List agenda items
Return a combined agenda between from and to (at most 93 days): due tasks plus due dates, expiries, tax deadlines, absences and holidays.
- sources picks the layers; each needs its own read scope, and unreadable layers are left out without error.
- The response sources lists the layers served; assignee_id filters tasks; one page.
Request
- Base URL: https://api.factuarea.com/v1
- URL: https://api.factuarea.com/v1/companies/{company}/agenda
- Auth: one of:
- HTTP bearer
- API key in header X-API-Key
Path parameters
Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).
Query parameters
First day of the window (YYYY-MM-DD, included). Required.
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.
Comma-separated agenda layers: tasks, invoice_due, purchase_invoice_due, quote_expiry, proforma_expiry, recurring_invoice_run, fiscal_deadline, absence, holiday; default all.
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
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.
Changes
No recorded changes to this operation across all 1 revision of this API.