Property Links

My client's property link

This endpoint returns a detailed or summary view of a single property link claimed by an individual or organisation. The view is determined by the optional projection query parameter which can take one of the values: ["summary", "detailed"].

Note that:

get/my-organisation/clients/all/property-links/{propertyLinkSubmissionId}

Path parameters

propertyLinkSubmissionIdstring required
Example:PLQQ2YMP

The submission ID of the property link

Query parameters

projection'summary' | 'detailed'

Return summary (simplified) projection, or detailed (full) view of the resource.

Headers

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

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

Response

MyClientsSummaryPropertyLinkResponseSchemaJson required— unresolved $ref
OR
MyClientsDetailedPropertyLinkResponseSchemaJson required— unresolved $ref