occupierAccounts
Looks up all occupier accounts for a postcode and optionally their last 4 digits of the account number.
Arguments
Returns
[OccupierAccount]Possible Errors
Allowed Viewers
Rate Limits
| Key | Steps |
|---|---|
ip |
['5/m'] |
Query Complexity
1Examples
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 OccupierAccounts(
$postcode: String!,
$shortcode: String
) {
occupierAccounts(
postcode: $postcode,
shortcode: $shortcode
) {
account
address
date
occupyToken
propertyId
}
}
Variables
{
"postcode": "fact-church-have-minute-best",
"shortcode": "generation-offer-analysis-spring-prepare"
}
Response
{
"data": {
"occupierAccounts": [
{
"account": "finish-fear-good-foot-security",
"address": "may-moment-chance-trial-for",
"date": "foreign-attention-woman-look-tree",
"occupyToken": "until-wide-spring-understand-two",
"propertyId": 17529695
}
]
}
}