Skip to main content

GET /contact-details/v1/{mpid}?mpan_id=...

Returns the latest contact details for one MPAN owned by the supplier.

Request​

Method and path:

  • GET /contact-details/v1/{mpid}?mpan_id=1234567890123

Headers:

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

Path parameters:

  • mpid (required): string supplier MPID.

Query parameters:

  • mpan_id (required): integer MPAN core.

Request body:

  • None.

Response​

Success:

  • 200 OK
  • Body: contact details response object
{
  "mpan_core": 1234567890123,
  "settlement_date_efd": "2026-03-20T00:00:00+00:00",
  "customers": [
    {
      "customer_name": "Jane Smith",
      "additional_information": "Prefers SMS after 6pm",
      "customer_password": "BLUE10",
      "customer_password_efd": "2026-03-20T00:00:00+00:00",
      "special_access": "Rear gate access",
      "max_power_req": 120,
      "delete_address_data": false,
      "mailing_address_1": "Flat 1",
      "mailing_address_2": "10 High Street",
      "mailing_address_postcode": "AB1 2CD",
      "contacts": [
        {
          "contact_name": "Jane Smith",
          "preferred_contact_method": "E",
          "telephones": [
            {
              "telephone_number": "+447539294787",
              "fax_number": null
            }
          ],
          "emails": [
            {
              "email_address": "jane.smith@example.com"
            }
          ]
        }
      ]
    }
  ]
}

No content case:

  • 204 No Content when no contact details are available for the MPAN.

Bad request case:

  • 400 Bad Request when mpan_id does not belong to the supplier or the MPAN is not found.

Field-level constraints: