Property Links

My client's property links

This endpoint returns a paginated list of property links for all the organisation's clients.

Filtering by client organisation name is supported and recommended.

Results can be sorted by one of the following sort fields:

* Sorting by this field is not supported in the developer Sandbox

Note that:

Agents can only access properties that have been assigned to them. Agents must be enrolled for the Find and check your business rates valuation online Service.

get/my-organisation/clients/all/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.

clientOrganisationstring

client's organsiation name to filter by

status'APPROVED' | 'PENDING' | 'DECLINED' | 'REVOKED' | 'MORE_EVIDENCE_REQUIRED'

The status of a property link to filter by

appointedFromDatestring date

Example:2020-01-31

Filters the results to include only property-links where appointedDate is on or after this date

appointedToDatestring date

Example:2020-12-31

Filters the results to include only property-links where appointedDate is on or before this date

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

Field to sort the results by

sortDirection'ASC' | 'DESC'

Results will be sorted in the specified direction (ascending or descending)

Accept'application/vnd.hmrc.2.0+json' required

Specifies the response format and the version of the API to be used

MyClientsPropertyLinksResponseSchemaJson required— unresolved $ref