Skip to main content

GET /notifications/v1/{mpid}

Returns notifications for a supplier, optionally filtered by receive time, completion status, and MPAN.

Request​

Method and path:

  • GET /notifications/v1/{mpid}?received_on=2026-03-20T00:00:00+00:00&completed=false&mpan_id=1234567890123

Headers:

  • X-API-KEY (required): string, API key used for tenant authorization.

Path parameters:

  • mpid (required): string supplier MPID.

Query parameters:

  • received_on (optional): string datetime in ISO 8601 format. Filters notifications received on or after this timestamp.
  • completed (optional): boolean. Defaults to false.
  • mpan_id (optional): integer MPAN core.

Request body:

  • None.

Response​

Success:

  • 200 OK
  • Body type: array of NotificationResponse
[
  {
    "id": "948a9974-b8c9-4f4d-bef1-70c1b8b30a78",
    "mpan_core": 1234567890123,
    "received_on": "2026-03-20T08:15:00+00:00",
    "notification_type": "RejectedConsumption",
    "detail": {
      "issuing_data_service_dip_id": "DIP-DC-001",
      "connection_type": "H",
      "connection_type_efd": "2026-01-01T00:00:00+00:00",
      "mqid": "AI"
    },
    "completed": false,
    "completed_on": null
  }
]

No content case:

  • 204 No Content when no notifications match the filters.

Validation error:

  • 422-style SSI validation response when received_on is not valid ISO 8601.

Full field definitions: