Notifications

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.

get/companies/{company}/notifications

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/notifications
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

Query parameters

status'unread' | 'read'

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

category'invoice' | 'quote' | 'proforma' | 'delivery_note' | 'purchase_invoice' | 'inventory' | 'verifactu' | 'error' | 'task'

Notification category, for example invoice, quote or task.

limitinteger

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

starting_afterstring uuid

Cursor for forward pagination: the id of the last notification you received.

Headers

Factuarea-Versionstring date
Example:2026-06-01

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.

Response

has_moreboolean required

true when there are more objects after this page.

next_cursorstring nullable required

Value to pass as starting_after to get the next page (the id of the last object), or null when has_more is false.

Example response

{
  "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",
      "created_at": "2026-09-28T07:58:12.000000Z",
      "updated_at": "2026-09-28T07:58:12.000000Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.