Get a paged list of existing estate agents, optionally filtered to the given parameters. A param-based alternative to the '/filter' POST endpoint.
Get Estate Agents Filtered and Paged (GET)
Retrieves a paged, optionally filtered list of existing estate agents using individual query parameters.
A developer calls this endpoint to search for estate agents matching one or more criteria (for example by name or address), or to retrieve the full set of estate agents in manageable pages when no filter is needed, such as for building a picker list or syncing records into another system.
This is a param-based alternative to the POST endpoint (POST /api/v1/relations/estateagents/filter).
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
pageSize | integer, 1 to 1000 | Optional | The number of estate agents to return per page. Defaults to 100 when not given. |
pageNumber | integer, 1 to 9999 | Optional | The page number to retrieve. Defaults to 1 when not given. |
name | string | Optional | Filters on the estate agent's name. |
reference | string | Optional | Filters on the estate agent's internal identifier (Reference/Code). |
externalIdentifier | string | Optional | Filters on the estate agent's external API identifier. |
phoneNumber | string | Optional | Filters on the estate agent's landline phone number. |
mobileNumber | string | Optional | Filters on the estate agent's mobile phone number. |
primaryEmailAddresses | string | Optional | Filters on the estate agent's primary email address(es). |
addressStreetAndHouseNumber | string | Optional | Filters on the combined street and house number of the estate agent's address. |
addressPostalCode | string | Optional | Filters on the postal code of the estate agent's address. |
addressCity | string | Optional | Filters on the city of the estate agent's address. |
addressCountryISOCode | string | Optional | Filters on the ISO 3166-1 alpha-2 country code of the estate agent's address. |
Response Fields
Field | Type | Required | Description |
|---|---|---|---|
paging.pageSize | integer, 1 to 1000, nullable | Optional | The page size used to produce this result set. |
paging.pageNumber | integer, 1 to 9999, nullable | Optional | The page number returned in this result set. |
sorting.columnName | string, nullable | Optional | The field the results are sorted by. |
sorting.order | integer (enum), nullable | Optional | The sort direction applied. Allowed values: 0 = Ascending, 1 = Descending. |
estateAgents | array of objects, nullable | Optional | The list of estate agents matching the filter for this page. See sub-fields below. |
estateAgents.name | string, nullable | Optional | The estate agent's registered or trading name. |
estateAgents.reference | string, nullable | Optional | The internal identifier (Reference/Code) of the estate agent. |
estateAgents.externalIdentifier | string, nullable | Optional | The external API identifier of the estate agent, if any. |
estateAgents.phoneNumber | string, nullable | Optional | The estate agent's landline phone number. |
estateAgents.mobileNumber | string, nullable | Optional | The estate agent's mobile phone number. |
estateAgents.primaryEmailAddresses | string, nullable | Optional | The estate agent's primary email address(es). Formatted as a single semicolon-separated string, consistent with the pattern confirmed for the Person search result. |
estateAgents.addressStreetAndHouseNumber | string, nullable | Optional | The combined street and house number of the estate agent's address, for example "Bredaseweg 12". |
estateAgents.addressPostalCode | string, nullable | Optional | The postal code of the estate agent's address. |
estateAgents.addressCity | string, nullable | Optional | The city of the estate agent's address. |
estateAgents.addressCountryISOCode | string, nullable | Optional | The ISO 3166-1 alpha-2 country code of the estate agent's address. |
estateAgents.archiveDate | string (date-time), nullable | Optional | The date and time from which the estate agent is archived, formatted as ISO 8601. Null if not archived. |
estateAgents.lastModified | string (date-time), nullable | Optional | The date and time the record was last modified, formatted as ISO 8601. |
The requested page size. Defaults to 100 when not given.
The requested page number. Defaults to 1 when not given.
Optional filter on the name of the estate agent.
Optional filter on the reference of the estate agent.
Optional filter on the external API identifier of the estate agent.
Optional filter on the phone number of the estate agent.
Optional filter on the mobile number of the estate agent.
Optional filter on the primary e-mail addressess of the estate agent.
Optional filter on the street and house number of the address of the estate agent.
Optional filter on the postal code of the address of the estate agent.
Optional filter on the city of the address of the estate agent.
Optional filter on the country ISO code of the address of the estate agent.
OK
Ascending = 0 Descending = 1