Skip to main content
GET
/
api
/
v1
/
notifications
curl --request GET \
  --url "${UNSTRUCTURED_API_URL}/api/v1/notifications?limit=50&unread_only=false" \
  --header "unstructured-api-key: ${UNSTRUCTURED_API_KEY}"

{
  "events": [
    {
      "id": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
      "event_type": "job.completed",
      "workflow_id": "f0a1b2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
      "payload": {
        "job_id": "b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e",
        "status": "COMPLETED"
      },
      "created_at": "2026-04-29T10:05:00Z",
      "is_read": false
    }
  ],
  "next_cursor": null
}

Documentation Index

Fetch the complete documentation index at: https://docs.unstructured.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Query parameters

​
workflow_id
string
Filter by workflow ID.
​
event_types
string
Comma-separated list of event types to filter by (e.g., job.completed,job.failed).
​
since
string
Return events created after this ISO 8601 timestamp.
​
limit
integer
Maximum number of events to return. Must be between 1 and 100. Default: 50.
​
cursor
string
Pagination cursor from a previous response.
​
unread_only
boolean
If true, return only unread events for the current user. Default: false.

​
Response

​
events
array
required
List of notification event objects.
​
next_cursor
string
Cursor for the next page of results. null if no further pages exist.
curl --request GET \
  --url "${UNSTRUCTURED_API_URL}/api/v1/notifications?limit=50&unread_only=false" \
  --header "unstructured-api-key: ${UNSTRUCTURED_API_KEY}"

{
  "events": [
    {
      "id": "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
      "event_type": "job.completed",
      "workflow_id": "f0a1b2c3-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
      "payload": {
        "job_id": "b2c3d4e5-6f7a-8b9c-0d1e-2f3a4b5c6d7e",
        "status": "COMPLETED"
      },
      "created_at": "2026-04-29T10:05:00Z",
      "is_read": false
    }
  ],
  "next_cursor": null
}