--- title: "Get persons filtered and paged" slug: "get-persons-filtered-and-paged" updated: 2026-02-10T08:37:41Z published: 2026-02-10T08:37:41Z --- > ## Documentation Index > Fetch the complete documentation index at: https://www.bloxs.io/llms.txt > Use this file to discover all available pages before exploring further. # Get persons filtered and paged Post/api/v1/relations/persons/filter Get a paged list of existing persons, optionally filtered to the given parameters. **Description** Retrieve a paged list of existing persons, optionally filtered to the given parameters. The Bloxs relations-api offers 2 options to get persons filtered and paged. One is through the POST option, and as an alternative there is a GET operation available. The functional difference is that the POST option offers the ability to sort the results. Furthermore, the POST includes the parameters in the body whereas the GET includes them in the url. Either reference or externalIdentifier must have a value. Please note that if both identifiers are given, both must match; otherwise, an error message will be generated. It is recommended that the user utilizes only one identifier, with a preference for the reference. A person is a standalone entity and pertains to an enhancement of organisation. This could be a contact person within an organisation. Several users utilize this to enter their own employees into the system. **Use Case** The Bloxs user has an external App connected to Bloxs. Through this operation the user can display a paged list of persons & the related information. This operation can be used if the user wants to display multiple persons rather than just a specific one. If the user wants to display a single person the preference is to use the GET (persons) operation. | Field | Description | | --- | --- | | pageSize | The maximum number of pages to be returned per request. The default number is 100 and the maximum is 1.000. If more results are returned than specified in the PageSize, the remaining pages are dropped based on the reference (number). | | pageNumber | This allows the requesting party to specify which of the pages they want to receive. | | columnName | The data field based on which sorting will be applied. For example, if the user wants to sort the results based on ascending name, the value 'name' should be given here. | | order | Based on this value, the property defined in 'columnName' will either be sorted ascending (a-z) or descending (z-a). | | externalIdentifier | The unique identifier within the system of the requesting party. This identifier is not generated by the Bloxs system. | | reference | The relationship number within Bloxs. This is unique (per client specific environment) for all relationships (EstateAgents, Organisations, Owners, Persons, Suppliers). The relationship number is generated by the Bloxs system. | | relationTypeName | Category of the person/organization. Categories are already defined in the system but can be configured by the customer. If you select a value that is not present in the list, the caller will receive a validation error. | | displayName | DisplayName can be used as another search term for a Person. It can be a combination of the FirstName, Initials, LastName & LastNamePrefix. The below logic applies to the compilation of the DisplayName: Only LastName Example: Sanden FirstName + LastName {LastName}, {FirstName} Example: Sanden, John FirstName + LastNamePrefix + LastName {LastName}, {FirstName} {LastNamePrefix} Example: Sanden, John van Initials + LastName {LastName}, {Initials} Example: Sanden, J Initials + LastNamePrefix + LastName {LastName}, {Initials} {LastNamePrefix} Example: Sanden, J van FirstName + Intials + LastName {LastName}, {FirstName} Example: Sanden, John FirstName + Intials + LastNamePrefix + LastName {LastName}, {FirstName} {LastNamePrefix} Example: Sanden, John van | | isActive | Boolean. A person can be archived. If the person is archived, then the status is inactive. True: Active False: Inactive | | dateOfBirth | The Date of birth of the person. This data needs to be entered in accordance with the ISO-8601 format. For example, somebody born on 25th of august 1980 should be entered as: 1980-08-25 | | phoneNumber | Phone number of the relation. | | mobileNumber | Mobile number of the relation. | | addressStreet | The street of the relation. | | addressPostalCode | The postal code of the relation. | | addressCity | The place of residence of the relation. | | email | Email address used by the relation. | | lastModified | Timestamp of the last modification within Bloxs (determined by Bloxs). | SecurityHTTPType Bearer Please enter a valid token Body parametersExpand Allobject pagingobject (PagingInfo) pageSizeinteger (int32) | null Minimum1Maximum1000 pageNumberinteger (int32) | null Minimum1Maximum9999 sortingobject (SortingInfo) columnNamestring | null orderinteger (int32) Valid values[ 0, 1 ] filterobject (PersonSearchRequestFilter) displayNamestring | null referencestring | null externalIdentifierstring | null relationTypeNamestring | null phoneNumberstring | null mobileNumberstring | null primaryEmailAddressesstring | null addressStreetAndHouseNumberstring | null addressPostalCodestring | null addressCitystring | null addressCountryISOCodestring | null archiveDateobject (CompareFilterModelDateTime) fromstring (date-time) | null tostring (date-time) | null lastModifiedobject (CompareFilterModelDateTime) fromstring (date-time) | null tostring (date-time) | null Responses200 OK Expand Allobject pagingobject (PagingInfo) pageSizeinteger (int32) | null Minimum1Maximum1000 pageNumberinteger (int32) | null Minimum1Maximum9999 sortingobject (SortingInfo) columnNamestring | null orderinteger (int32) Valid values[ 0, 1 ] persons Array of object (PersonSearchResultFilter) | null object displayNamestring | null referencestring | null externalIdentifierstring | null relationTypeNamestring | null phoneNumberstring | null mobileNumberstring | null primaryEmailAddressesstring | null addressStreetAndHouseNumberstring | null addressPostalCodestring | null addressCitystring | null addressCountryISOCodestring | null archiveDatestring (date-time) | null lastModifiedstring (date-time) | null