Llistar notificacions

Llista les notificacions a l'aplicació del membre titular de l'API key, de més recent a més antiga.

Filtra per status (unread o read) i category; les notificacions arxivades mai apareixen.
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.

Paràmetres de consulta

status?string

Estat de lectura: unread o read. Omet-lo per llistar-los tots dos. Les notificacions arxivades mai apareixen.

Valor a"unread" | "read"

category?string

Categoria de la notificació, per exemple invoice, quote o task.

limit?integer

Nombre de notificacions 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 notificació de la pàgina anterior (el next_cursor que vas rebre). Un id que no és una de les teves notificacions 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`

Exemple de petició

const apiKey = process.env.FACTUAREA_API_KEY;if (!apiKey) throw new Error("Set FACTUAREA_API_KEY");const response = await fetch("https://api.factuarea.com/v1/notifications?limit=25", {  method: "GET",  headers: { Authorization: `Bearer ${apiKey}`, ...{"Accept":"application/json"} },});if (!response.ok) throw new Error(await response.text());if (response.status !== 204) console.log(await response.json());

Exemple de resposta

{
  "data": [
    {
      "id": "0193a4f2-b2ec-7add-8b7e-6d8e0f2a4c01",
      "object": "notification",
      "type": "sistema",
      "category": "task",
      "title": "Te han asignado la tarea DEV-12",
      "message": "Se te ha asignado la tarea DEV-12 «Integrar la pasarela de pago en el checkout».",
      "priority": "medium",
      "status": "unread",
      "entity_type": "task",
      "entity_id": null,
      "created_at": "2026-09-28T07:58:12.000000Z",
      "updated_at": "2026-09-28T07:58:12.000000Z"
    },
    {
      "id": "0193a4f2-b2ec-7add-8b7e-6d8e0f2a4c02",
      "object": "notification",
      "type": "recordatorio",
      "category": "task",
      "title": "DEV-13 está vencida",
      "message": "La tarea DEV-13 «Revisar los textos legales del pie de página» venció el 26/09/2026 y sigue abierta.",
      "priority": "high",
      "status": "unread",
      "entity_type": "task",
      "entity_id": null,
      "created_at": "2026-09-27T06:00:03.000000Z",
      "updated_at": "2026-09-27T06:00:03.000000Z"
    },
    {
      "id": "0193a4f2-b2ec-7add-8b7e-6d8e0f2a4c03",
      "object": "notification",
      "type": "financiero",
      "category": "invoice",
      "title": "Factura FAC-2026-00038 vencida",
      "message": "La factura FAC-2026-00038 de Acme Soluciones SL lleva 3 días vencida.",
      "priority": "high",
      "status": "read",
      "entity_type": "invoice",
      "entity_id": "0193a4f2-d40e-7cff-8d90-8f0a2b4c6e11",
      "created_at": "2026-09-25T14:21:40.000000Z",
      "updated_at": "2026-09-26T08:03:11.000000Z"
    }
  ],
  "has_more": true,
  "next_cursor": "0193a4f2-b2ec-7add-8b7e-6d8e0f2a4c03"
}

{
  "error": {
    "type": "authentication_error",
    "code": "missing_api_key",
    "message": "Falta header Authorization o X-API-Key.",
    "doc_url": "https://docs.factuarea.com/guides/errors#missing_api_key",
    "request_id": "req_ba4b86fe46a63e90266064ec5f"
  }
}

{
  "error": {
    "type": "authorization_error",
    "code": "insufficient_scope",
    "message": "Esta operación requiere el scope 'notifications:read'. Tu API key solo tiene los scopes: ninguno.",
    "doc_url": "https://docs.factuarea.com/guides/errors#insufficient_scope",
    "request_id": "req_b48ebcbd1cc308cbb5b7f45c15"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_param_value",
    "message": "El estado no es válido. Los valores permitidos son: unread, read.",
    "param": "status",
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_param_value",
    "request_id": "req_c41b990e12e5da28e6e646c6aa"
  }
}

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Has excedido el límite de requests permitido. Reintenta más tarde.",
    "doc_url": "https://docs.factuarea.com/guides/errors#rate_limit_exceeded",
    "request_id": "req_b385ce598bbca75f93092ccd49"
  }
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "Algo se rompió en nuestro lado al procesar la petición. La condición no la provoca tu payload.",
    "doc_url": "https://docs.factuarea.com/guides/errors#internal_error",
    "request_id": "req_eeb61e013904a455acacffbeaa"
  }
}

Llistar notificacions

Authorization

Paràmetres de consulta

Headers

Cos de la resposta

200application/json

401application/json

403application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`