---
title: "List notifications"
method: GET
path: "/companies/{company}/notifications"
tags: ["Notifications"]
---

# List notifications

`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`

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.

## Path parameters

- `company` string, uuid, required

## Query parameters

- `status` 'unread' | 'read'
- `category` 'invoice' | 'quote' | 'proforma' | 'delivery_note' | 'purchase_invoice' | 'inventory' | 'verifactu' | 'error' | 'task'
- `limit` integer
- `starting_after` string, uuid

## Headers

- `Factuarea-Version` string, date

## Response `200`

- object: Page of notifications (`{ data, has_more, next_cursor }`).
  - `data` object[], required: Items on the current page.
    - `id` string, uuid, required: UUID v7 of the notification.
    - `object` 'notification', required: Stripe-like discriminator. Always `notification` for this resource.
    - `type` string, required: Kind of notification.
    - `category` string, required: Category (`invoice`, `quote`, `task`…).
    - `title` string, required
    - `message` string, required
    - `priority` string, required
    - `status` 'unread' | 'read', required: Read status. Archived notifications are never returned.
    - `entity_type` string, nullable, required: Type of the related resource, or `null`.
    - `entity_id` string, uuid, nullable, required: UUID of the related resource, or `null`. For task notifications (`entity_type` = `task`) it is the UUID of the task, ready for `GET /v1/companies/{company}/tasks/{task}`.
    - `created_at` string, date-time, required: Creation timestamp.
    - `updated_at` string, date-time, required: Last update timestamp.
  - `has_more` boolean, required: `true` when there are more objects after this page.
  - `next_cursor` string, 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`.

## Other responses

- `400`: `parameter_unknown` with `subcode` `retired_active_profile_header`: the retired `X-Active-Profile` header was sent; the company goes in the path. `parameter_invalid_format` on `Factuarea-Version`: the header is not a `YYYY-MM-DD` date. `unsupported_api_version`: the `Factuarea-Version` date is not a supported version.
- `401`: Missing or invalid API key.
- `403`: The request is authenticated but not allowed: the API key lacks the required scope (`insufficient_scope`), the plan does not include the public API or this feature (`addon_not_active`, `feature_not_available_in_plan`), or the module is not available with a test key (`module_not_available_in_sandbox`).
- `404`: The requested resource does not exist or belongs to another company. `profile_not_found`: the company in the path does not exist, is not in the API key scope or belongs to the other environment (live or test).
- `422`: Validation failed. The `error.param` field identifies which input is invalid.
- `429`: Rate limit exceeded. Retry after the duration in `Retry-After`.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/factuarea/apis/factuarea-public-api.md) · [All operations](https://skmtc.dev/factuarea/apis/factuarea-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/factuarea/apis/factuarea-public-api/revisions/718e77934422?raw)