List notifications

List the in-app notifications of the member who owns the API key, newest first.

Filter by status (unread or read) and category; archived notifications never appear.
Cursor-paginated: pass the next_cursor of a page as starting_after to get the next one; has_more tells whether there are more.

Query Parameters

status?string

Read status: unread or read. Omit it to list both. Archived notifications never appear.

Value in"unread" | "read"

category?string

Notification category, for example invoice, quote or task.

limit?integer

Number of notifications to return. Integer between 1 and 100. Defaults to 25.

Range1 <= value <= 100

starting_after?string

Cursor for forward pagination: the id of the last notification of the previous page (the next_cursor you received). An id that is not one of your notifications returns 422 invalid_param_value.

Formatuuid

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`

Request example

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());

Response example

{
  "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"
  }
}

List notifications

Authorization

Query Parameters

Headers

Response Body

200application/json

401application/json

403application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`