Agents

My clients

This endpoint returns a list of an agent's clients.

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/clients

Query parameters

clientOrganisationstring

This parameter allows you to filter your clients by the start of their organisation's name

appointedFromDatestring date

Example:2020-01-31

Filters the results to include only clients appointed on or after this date

appointedToDatestring date

Example:2020-12-31

Filters the results to include only clients appointed 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

Headers

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

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

Response

GetMyClientsResponseSchemaJson required— unresolved $ref