List notifications
Lists your most recent notifications.
GET/v1/workspaces/{regionId}/notifications
Parameters
audience"buyer" | "supplier"RequiredWhich side's notification feed to return.
Returns
200 OK with the object shown in the response.
More details
Lists up to the 50 most recent notifications for the given audience, newest first. Notifications are kept for 90 days. Use ListNotificationsPage to page through older ones.
Response fields
title, bodystringEnglish, as written when the notification was created. Slack, Teams and email show the same text.
titleMessageId, titleParams, bodyMessageId, bodyParamsstring, objectThe message each text was built from and the values it was filled with, so an app can show it in its reader's language. Absent on notifications created before they existed; show title and body then.
resolutionobjectOnly on an approval request (po_approval_requested, invoice_approval_requested) or a needs-an-approver notice (po_needs_approver, invoice_needs_approver) that no longer needs its reader, worked out when listed and never stored: outcome you_approved or you_rejected (with at) when the reader decided the step, otherwise no_longer_needed (someone else decided, the step was reassigned, or the document left approval). Absent while it still needs them.
Errors
- 401 Unauthorized - No credential was presented, or the Bearer token / X-Api-Key value is missing, invalid, expired, or revoked.
- 403 Forbidden - The caller's Bearer token or API key doesn't grant access to this workspace (regionId), or lacks the required role.
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/notifications" \
-H "X-Api-Key: $PLEAXY_API_KEY"[
{
"id": "string",
"audience": "buyer" | "supplier",
"type": "report_ready" | "company_report_ready" | "po_approved" | "po_rejected" | "po_canceled" | "po_changed" | "po_approval_requested" | "request_approval_requested" | "request_approved" | "request_rejected" | "request_ordered" | "po_store_order_problem" | "po_supplier_confirmed" | "po_supplier_exception" | "po_shipped" | "po_supplier_email" | "po_changes_declined" | "po_needs_approver" | "invoice_submitted" | "invoice_ready_for_approval" | "invoice_approval_requested" | "invoice_discrepancy" | "invoice_approved" | "invoice_paid" | "invoice_payment_withdrawn" | "payments_recorded_by_key" | "accounting_sync_failed" | "invoice_remittance_sent" | "invoice_payment_failed" | "invoice_reminder" | "invoice_rejected" | "invoice_on_hold" | "invoice_hold_released" | "invoice_payment_reminder" | "invoice_entered_by_buyer" | "invoice_bank_details_to_confirm" | "invoice_bank_details_confirmed" | "invoice_bank_details_disputed" | "invoice_bank_details_changed" | "invoice_needs_approver" | "ses_approval_requested" | "ses_auto_approved" | "ses_approved" | "ses_rejected" | "receipt_return_recorded" | "po_line_due" | "po_line_due_asked" | "po_receipt_requested" | "invoice_held_due_soon" | "ses_approval_overdue" | "credit_note_received" | "credit_note_accepted" | "credit_note_rejected" | "credit_note_applied" | "invoice_comment" | "po_comment" | "contract_comment" | "invoice_feed_changed" | "supplier_connection_invited" | "supplier_connection_submitted" | "supplier_connection_approved" | "supplier_connection_rejected" | "supplier_connection_region_mismatch" | "agent_request" | "support_case_opened" | "support_case_updated" | "supplier_late_fee_terms_changed" | "contract_terms_to_acknowledge" | "contract_terms_acknowledged" | "contract_terms_disputed" | "contract_recheck_requested" | "contract_sent_to_joined_supplier" | "copilot_allowance_80" | "copilot_allowance_100" | "copilot_degraded" | "copilot_packs_low" | "copilot_packs_empty" | "copilot_payg_cap",
"title": "string",
"body": "string",
"titleMessageId": "string",
"titleParams": { },
"bodyMessageId": "string",
"bodyParams": { },
"relatedId": "string",
"createdAt": "string",
"read": boolean,
"resolution": { "outcome": "you_approved" | "you_rejected" | "no_longer_needed", "at": "string" }
}
]