KT-CT-1113: Disabled GraphQL field requested.
KT-CT-7899: An internal error occurred.
KT-GB-6611: We couldn't find a match for this postcode. Please verify it and try again.
KT-GB-6620: Invalid data.
KT-GB-6630: We can't communicate with our address database right now to look up your address. Please try again.
KT-GB-6638: Too many results returned for the provided postcode.

Allowed Viewers

Customer

Partner User

Third party

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

query AddressUprns(
  $after: String,
  $before: String,
  $electricityOnly: Boolean,
  $first: Int,
  $last: Int,
  $postcode: String!
) {
  addressUprns(
    after: $after,
    before: $before,
    electricityOnly: $electricityOnly,
    first: $first,
    last: $last,
    postcode: $postcode
  ) {
    edgeCount
    edges {
      ...AddressUPRNTypeEdgeFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
    totalCount
  }
}

Variables

{
  "after": "YXJyYXljb25uZWN0aW9uOjEw=",
  "before": "YXJyYXljb25uZWN0aW9uOjEw=",
  "electricityOnly": true,
  "first": 10,
  "last": 10,
  "postcode": "green-even-worker-training-pressure"
}

Response

{
  "data": {
    "addressUprns": {
      "edgeCount": 61,
      "edges": [AddressUPRNTypeEdge],
      "pageInfo": PageInfo,
      "totalCount": 90
    }
  }
}