Skip to main content

GET /mpan/v1/{mpid}/list

Returns all MPANs associated with the supplier identified by mpid (scoped by X-API-KEY).

Request​

Method and path:

  • GET /mpan/v1/{mpid}/list

Headers:

  • X-API-KEY (required): string, UUID format.

Path parameters:

  • mpid (required): string supplier MPID.

Request body:

  • None.

Response​

Success:

  • 200 OK
  • Body type: MpanResponseSchema
{
  "mpans": [
    {
      "id": 1234567890123,
      "address_line_1": "10 High Street",
      "postcode": "AB1 2CD",
      "registration_id": "9f905e25-77da-47df-b7bc-1f1d2ed12abc",
      "supply_start_date": "2026-01-16T00:00:00+00:00",
      "registration_status": "Active"
    }
  ]
}

Notes:

  • If no MPANs exist for the supplier, response is still 200 with {"mpans": []}.

Auth/tenant errors:

  • 401 when credentials cannot access the requested MPID.
  • 403 when supplier access is forbidden for the API key.

Full field definitions: