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)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/notifications/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/notifications/ \
--header 'Authorization: Bearer <token>'{
"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"
}
]
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"error": "Not found."
}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
statusquery parameter
Impersonation:
When using the X-Impersonate-Email header, returns notifications for the target user
instead of the authenticated user.
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)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/notifications/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/notifications/ \
--header 'Authorization: Bearer <token>'{
"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"
}
]
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"error": "Not found."
}Authorizations
Use Authorization: Bearer <token>. The token is either a user token / OAuth access
token, or a service-account API key (cfk_...). A key is valid on every endpoint and
acts as its service account, an organization member with per-store permissions.
Refused keys answer 403 with Invalid API key., API key revoked.,
API key expired. or API key disabled..
Headers
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
UUID of the project
Query Parameters
Filter by notification status
unread: Notification has not been readread: Notification has been read
unread, read Maximum number of results per page
1 <= x <= 1000Number of results to skip for pagination
x >= 0