siteworksBookingAccountSearchByMprn

Get siteworks booking information for an account given an MPRN.

Deprecation

The 'siteworksBookingAccountSearchByMprn' field is deprecated.

Please use getOnSiteJobsAccountBySupplyPointExternalIdentifier instead.

- Marked as deprecated on 2026-07-20.
- Scheduled for removal on or after 2026-10-20.

Arguments

mprn : String!


            required

The MPRN to search for.

Returns

SiteworksBookingAccountType

An object holding information about an account and its associated users, properties and meter points, used for administering siteworks bookings.

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Required Permissions

Can book smart meter appointments
OR Can query accounts by property postcode
OR Can query siteworks account
OR Can update smart meter interest

Query Complexity

Examples

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

query SiteworksBookingAccountSearchByMprn($mprn: String!) {
  siteworksBookingAccountSearchByMprn(mprn: $mprn) {
    accountType
    activeCampaigns {
      ...SiteworksCampaignTypeFragment
    }
    billingName
    brand
    canModifyPayments {
      ...CanModifyPaymentsTypeFragment
    }
    marketSupplyAgreements {
      ...AgreementConnectionFragment
    }
    number
    properties {
      ...SiteworksBookingPropertyTypeFragment
    }
    smets2Interest
    status
    users {
      ...AccountUserTypeFragment
    }
  }
}

{
  "mprn": "he-oil-detail-style-continue"
}

{
  "data": {
    "siteworksBookingAccountSearchByMprn": {
      "accountType": "play-face-rather-at-beyond",
      "activeCampaigns": [SiteworksCampaignType],
      "billingName": "throw-dog-already-push-measure",
      "brand": "director-data-ball-activity-action",
      "canModifyPayments": CanModifyPaymentsType,
      "marketSupplyAgreements": AgreementConnection,
      "number": "ever-determine-both-present-large",
      "properties": [SiteworksBookingPropertyType],
      "smets2Interest": "PRIORITY",
      "status": "PENDING",
      "users": [AccountUserType]
    }
  }
}