Property Links
My organisation's property links
This endpoint returns a paginated list of property links claimed by an individual or organisation.
<p>Results can be sorted by one of the following sort fields:</p> <ul> <li>ADDRESS</li> <li>AGENT<sup>*</sup></li> <li>BAREF</li> <li>CREATED_DATE_TIME</li> <li>STATUS</li> </ul> <p><sup>*</sup> Sorting by this field is not supported in the developer Sandbox</p>Note that:
<ul class="list-bullet"> <li class="font-xsmall"> Individuals or organisations can only access their own data, and must be enrolled for the <a href="https://www.gov.uk/correct-your-business-rates" target="_blank">Find and check your business rates valuation</a> online service. </li> </ul>get/my-organisation/property-links
Query parameters
addressstring
Address, or part of the address (e.g. street name or postcode), to filter by
uarninteger
Example:12345678901
The Unique Address Reference Number (UARN) of the property
billingAuthorityReferencestring required
Filters the results to include properties which are inside the provided billing authority.
status'APPROVED' | 'PENDING' | 'DECLINED' | 'REVOKED' | 'MORE_EVIDENCE_REQUIRED'
The status of a property link to filter by
pageinteger
The results for this endpoint are paginated and this refers to the page number
pageSizeinteger
The results for this endpoint are paginated and this refers to the number of elements per page
sortField'ADDRESS' | 'AGENT' | 'BAREF' | 'CREATED_DATE_TIME' | 'STATUS'
Field to sort the results by
sortDirection'ASC' | 'DESC'
Results will be sorted in the specified direction (ascending or descending)
Headers
Accept'application/vnd.hmrc.2.0+json' required
Specifies the response format and the version of the API to be used
Response
MyOrganisationsPropertyLinksResponseSchemaJson required— unresolved $ref