List notifications.

Return paginated in-app notifications for the authenticated member of an organization.

Authorization

sb-auth-token<token>

Supabase browser session cookie. Supabase may split larger session values into chunked cookies like sb-auth-token.0.

In: cookie

Query Parameters

offset*string

limit*string

q?string

Lengthlength <= 200

status*string

Default"all"

Value in

"all"
"unread"
"read"

type?string

Value in

"task.assigned"
"task.comment"
"task.updated"
"collaboration.mention"
"collaboration.note"
"task.due-soon"
"task.overdue"
"agenda.assigned"
"agenda.updated"
"agent.approval-required"
"agent.run-failed"
"agent.run-completed"
"workflow.approval-required"
"workflow.run-failed"
"workflow.run-completed"
"workflow.notification"
"inbox.message"
"quote.sent"
"quote.viewed"
"quote.accepted"
"quote.rejected"
"quote.changes-requested"
"quote.expired"
"quote.deposit-paid"
"invoice.paid"
"invoice.overdue"
"invoice.viewed"
"invoice.partially-paid"
"invoice.payment-failed"
"invoice.disputed"
"invoice.final-notice-sent"
"order.backordered"
"order.confirmed"
"shipment.exception"
"purchase-order.received"
"purchase-order.overdue"
"inventory.low-stock"
"task.stage-changed"
"billing.usage-threshold"
"organization.invite"
"organization.membership-updated"
"time-off.requested"
"time-off.decided"
"time-off.cancelled"
"sick-leave.reported"
"sick-leave.returned"
"sick-leave.follow-up"
"timesheet.submitted"
"timesheet.decided"
"expense.submitted"
"expense.decided"
"expense.reimbursed"
"employee.document-expiring"
"employee.contract-ending"
"equipment.assigned"
"onboarding.item-assigned"
"hiring.application-received"
"time.timer-forgotten"
"time.budget-warning"
"approval.requested"
"approval.decided"
"approval.escalated"

subjectType?string

Value in

"task"
"customer"
"agenda-item"
"agent-run"
"billing"
"organization"
"workflow-run"
"inbox-thread"
"quote"
"invoice"
"chat-thread"
"artifact"
"employee"
"time-off-request"
"timesheet"
"expense"
"hiring-application"
"employee-journey"
"approval"
"order"
"shipment"
"purchase-order"
"product"

group*string

Default"all"

Value in

"all"
"needs-action"
"running"
"happened"

Response Body

`application/json`

`application/problem+json`

curl -X GET "https://example.com/v1/organizations/123/notifications?offset=example&limit=example&q=example&status=all&type=example&subjectType=example&group=all"

{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "eventId": "d6703cc8-9e79-415d-ac03-a4dc7f6ab43c",      "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",      "recipientUserId": "b75206a2-d744-4b29-9351-fc8f8b811db2",      "type": "task.assigned",      "priority": "low",      "actorUserId": "94141e08-adc7-44ce-bed3-45f031b9f36f",      "actor": {        "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",        "displayName": "string",        "avatarUrl": "string"      },      "originator": {        "kind": "user",        "displayName": "string",        "avatarUrl": "string"      },      "subjectType": "task",      "subjectId": "string",      "subjectLabel": "string",      "summary": "string",      "actionPath": "string",      "metadata": {        "property1": "string",        "property2": "string"      },      "readAt": "2019-08-24T14:15:22Z",      "dismissedAt": "2019-08-24T14:15:22Z",      "resolvedAt": "2019-08-24T14:15:22Z",      "deliveredAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z"    }  ],  "pagination": {    "offset": 0,    "limit": 1,    "total": 0,    "hasMore": true,    "totalIsEstimate": true  }}

Query Parameters

offset*string

limit*string

q?string

Lengthlength <= 200

status*string

Default"all"

Value in

"all"
"unread"
"read"

type?string

Value in

"task.assigned"
"task.comment"
"task.updated"
"collaboration.mention"
"collaboration.note"
"task.due-soon"
"task.overdue"
"agenda.assigned"
"agenda.updated"
"agent.approval-required"
"agent.run-failed"
"agent.run-completed"
"workflow.approval-required"
"workflow.run-failed"
"workflow.run-completed"
"workflow.notification"
"inbox.message"
"quote.sent"
"quote.viewed"
"quote.accepted"
"quote.rejected"
"quote.changes-requested"
"quote.expired"
"quote.deposit-paid"
"invoice.paid"
"invoice.overdue"
"invoice.viewed"
"invoice.partially-paid"
"invoice.payment-failed"
"invoice.disputed"
"invoice.final-notice-sent"
"order.backordered"
"order.confirmed"
"shipment.exception"
"purchase-order.received"
"purchase-order.overdue"
"inventory.low-stock"
"task.stage-changed"
"billing.usage-threshold"
"organization.invite"
"organization.membership-updated"
"time-off.requested"
"time-off.decided"
"time-off.cancelled"
"sick-leave.reported"
"sick-leave.returned"
"sick-leave.follow-up"
"timesheet.submitted"
"timesheet.decided"
"expense.submitted"
"expense.decided"
"expense.reimbursed"
"employee.document-expiring"
"employee.contract-ending"
"equipment.assigned"
"onboarding.item-assigned"
"hiring.application-received"
"time.timer-forgotten"
"time.budget-warning"
"approval.requested"
"approval.decided"
"approval.escalated"

subjectType?string

Value in

"task"
"customer"
"agenda-item"
"agent-run"
"billing"
"organization"
"workflow-run"
"inbox-thread"
"quote"
"invoice"
"chat-thread"
"artifact"
"employee"
"time-off-request"
"timesheet"
"expense"
"hiring-application"
"employee-journey"
"approval"
"order"
"shipment"
"purchase-order"
"product"

group*string

Default"all"

Value in

"all"
"needs-action"
"running"
"happened"

{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "eventId": "d6703cc8-9e79-415d-ac03-a4dc7f6ab43c", "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "recipientUserId": "b75206a2-d744-4b29-9351-fc8f8b811db2", "type": "task.assigned", "priority": "low", "actorUserId": "94141e08-adc7-44ce-bed3-45f031b9f36f", "actor": { "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b", "displayName": "string", "avatarUrl": "string" }, "originator": { "kind": "user", "displayName": "string", "avatarUrl": "string" }, "subjectType": "task", "subjectId": "string", "subjectLabel": "string", "summary": "string", "actionPath": "string", "metadata": { "property1": "string", "property2": "string" }, "readAt": "2019-08-24T14:15:22Z", "dismissedAt": "2019-08-24T14:15:22Z", "resolvedAt": "2019-08-24T14:15:22Z", "deliveredAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z" } ], "pagination": { "offset": 0, "limit": 1, "total": 0, "hasMore": true, "totalIsEstimate": true }}

List notifications.

List notifications.

Authorization

Path Parameters

Query Parameters

Response Body

`application/json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

Authorization

Path Parameters

Query Parameters

Response Body

`application/json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

List notifications.

List notifications.

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/problem+json

401application/problem+json

403application/problem+json

404application/problem+json

409application/problem+json

500application/problem+json

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/problem+json

401application/problem+json

403application/problem+json

404application/problem+json

409application/problem+json

500application/problem+json

Authorization

Path Parameters

Query Parameters

Response Body

`application/json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

Authorization

Path Parameters

Query Parameters

Response Body

`application/json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`