Supplier Integration

Get sites and meters for a business

Returns all sites and meters for a business, organised by supplier account. Each site includes its supply types (electricity/gas) and associated meter details (MPAN/MPRN and serial numbers).

get/v1/suppliers/references/{referenceId}/accountsSitesMeters

Path parameters

referenceIdstring required

Business ID

Query parameters

supplierstring

Filter to accounts from a specific supplier (SupplierType id or name).

Response

Accounts with sites and meters retrieved successfully

businessIdstring

Changes

Changed in 2 of the 13 revisions of this API.1010

    • the response property accounts became optional for the status 200

      response-property-became-optional

    • the response property accounts/items/id became optional for the status 200

      response-property-became-optional

    • the response property accounts/items/sites became optional for the status 200

      response-property-became-optional

    • the response property accounts/items/sites/items/accountId became optional for the status 200

      response-property-became-optional

    • the response property accounts/items/sites/items/id became optional for the status 200

      response-property-became-optional

    • the response property accounts/items/sites/items/meters became optional for the status 200

      response-property-became-optional

    • the response property accounts/items/sites/items/meters/items/utilityType became optional for the status 200

      response-property-became-optional

    • the response property accounts/items/sites/items/supplyTypes became optional for the status 200

      response-property-became-optional

    • the response property accounts/items/supplier became optional for the status 200

      response-property-became-optional

    • the response property businessId became optional for the status 200

      response-property-became-optional

    • the response property accounts became required for the status 200

      response-property-became-required

    • the response property accounts/items/id became required for the status 200

      response-property-became-required

    • the response property accounts/items/sites became required for the status 200

      response-property-became-required

    • the response property accounts/items/sites/items/accountId became required for the status 200

      response-property-became-required

    • the response property accounts/items/sites/items/id became required for the status 200

      response-property-became-required

    • the response property accounts/items/sites/items/meters became required for the status 200

      response-property-became-required

    • the response property accounts/items/sites/items/meters/items/utilityType became required for the status 200

      response-property-became-required

    • the response property accounts/items/sites/items/supplyTypes became required for the status 200

      response-property-became-required

    • the response property accounts/items/supplier became required for the status 200

      response-property-became-required

    • the response property businessId became required for the status 200

      response-property-became-required

    This revision also has 21 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog