Get a paged list of existing owners, optionally filtered to the given parameters.
Get Owners Filtered and Paged (POST)
Retrieves a paged, optionally filtered list of existing owners using a JSON request body.
A developer calls this endpoint to search for owners matching one or more criteria (for example by name, address, or date range), or to retrieve the full set of owners in manageable pages when no filter is needed, such as for building a picker list or syncing records into another system.
This endpoint offers a broader set of filter criteria than its GET alternative (GET /api/v1/relations/owners/filter), including filtering by archive date and last-modified date.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
paging.pageSize | integer, 1 to 1000, nullable | Optional | The number of owners to return per page. Defaults to 100 when not given. |
paging.pageNumber | integer, 1 to 9999, nullable | Optional | The page number to retrieve. Defaults to 1 when not given. |
sorting.columnName | string, nullable | Optional | The name of the field to sort the results by. |
sorting.order | integer (enum), nullable | Optional | The sort direction. Allowed values: 0 = Ascending, 1 = Descending. |
filter.name | string, nullable | Optional | Filters on the owner's name. |
filter.reference | string, nullable | Optional | Filters on the owner's internal identifier (Reference/Code). |
filter.externalIdentifier | string, nullable | Optional | Filters on the owner's external API identifier. |
filter.phoneNumber | string, nullable | Optional | Filters on the owner's landline phone number. |
filter.mobileNumber | string, nullable | Optional | Filters on the owner's mobile phone number. |
filter.primaryEmailAddresses | string, nullable | Optional | Filters on the owner's primary email address(es). |
filter.addressStreetAndHouseNumber | string, nullable | Optional | Filters on the combined street and house number of the owner's address. |
filter.addressPostalCode | string, nullable | Optional | Filters on the postal code of the owner's address. |
filter.addressCity | string, nullable | Optional | Filters on the city of the owner's address. |
filter.addressCountryISOCode | string, nullable | Optional | Filters on the ISO 3166-1 alpha-2 country code of the owner's address. |
filter.archiveDate.from | string (date-time), nullable | Optional | Inclusive lower bound for filtering on archive date, formatted as ISO 8601 (for example "2026-01-01T00:00:00Z"). If omitted, there is no lower bound. |
filter.archiveDate.to | string (date-time), nullable | Optional | Inclusive upper bound for filtering on archive date, formatted as ISO 8601. If omitted, there is no upper bound. |
filter.lastModified.from | string (date-time), nullable | Optional | Inclusive lower bound for filtering on the date the record was last modified, formatted as ISO 8601. If omitted, there is no lower bound. |
filter.lastModified.to | string (date-time), nullable | Optional | Inclusive upper bound for filtering on the date the record was last modified, formatted as ISO 8601. If omitted, there is no upper bound. |
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. |
owners | array of objects, nullable | Optional | The list of owners matching the filter for this page. See sub-fields below. |
owners.name | string, nullable | Optional | The owner's registered or trading name. |
owners.reference | string, nullable | Optional | The internal identifier (Reference/Code) of the owner. |
owners.externalIdentifier | string, nullable | Optional | The external API identifier of the owner, if any. |
owners.phoneNumber | string, nullable | Optional | The owner's landline phone number. |
owners.mobileNumber | string, nullable | Optional | The owner's mobile phone number. |
owners.primaryEmailAddresses | string, nullable | Optional | The owner's primary email address(es). Formatted as a single semicolon-separated string, consistent with the pattern confirmed for the Person search result. |
owners.addressStreetAndHouseNumber | string, nullable | Optional | The combined street and house number of the owner's address, for example "Bredaseweg 12". |
owners.addressPostalCode | string, nullable | Optional | The postal code of the owner's address. |
owners.addressCity | string, nullable | Optional | The city of the owner's address. |
owners.addressCountryISOCode | string, nullable | Optional | The ISO 3166-1 alpha-2 country code of the owner's address. |
owners.archiveDate | string (date-time), nullable | Optional | The date and time from which the owner is archived, formatted as ISO 8601. Null if not archived. |
owners.lastModified | string (date-time), nullable | Optional | The date and time the record was last modified, formatted as ISO 8601. |
Ascending = 0 Descending = 1
OK
Ascending = 0 Descending = 1