List project notifications

List notifications for the effective user (authenticated user or impersonated user).

Filtering:

• Only PROJECT-scoped notifications are returned (not account-level)
• Returns all unread notifications plus read notifications from the last 7 days
• Optionally filter by status using the status query parameter

Impersonation: When using the X-Impersonate-Email header, returns notifications for the target user instead of the authenticated user.

GET /projects/{project_id}/notifications

List project notifications

Python

import requests

url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/notifications/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

200

{
  "count": 123,
  "next": "<string>",
  "previous": "<string>",
  "results": [
    {
      "scope": "project",
      "project": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "user": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "unread",
      "access_level": "admin",
      "title": "Document processing completed",
      "message": "Your document 'Q4 Report.pdf' has been processed successfully.",
      "notification_type": "document_processed",
      "actions": {
        "primary": {
          "label": "View Document",
          "type": "navigate",
          "url": "/documents/123"
        }
      },
      "read_at": "2023-11-07T05:31:56Z",
      "source_object_type": "document",
      "source_object_id": "550e8400-e29b-41d4-a716-446655440000",
      "relative_time": "2 hours ago",
      "absolute_time": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

BearerAuthTokenAuth

Authorization · string · header · required

Use Authorization: Bearer

Headers

X-Impersonate-Email · string<email>

Email of the user to impersonate. Requires CAN_IMPERSONATE_OTHER_USERS permission. If the target user is not found or does not have access to the project, the request proceeds as the authenticated user. Contact Clarifeye to enable this permission.

Path Parameters

project_id · string<uuid> · required

UUID of the project

Query Parameters

status · enum<string>

Filter by notification status

• unread: Notification has not been read
• read: Notification has been read

Available options: unread, read

limit · integer · default: 100

Maximum number of results per page

Required range: 1 <= x <= 1000

offset · integer · default: 0

Number of results to skip for pagination

Required range: x >= 0

Response

200

application/json

Successful response

count · integer

Total number of results

next · string<uri> | null

URL to next page of results

previous · string<uri> | null

URL to previous page of results

results · object[]

Show child attributes