Get a paged list of existing organisations, optionally filtered to the given parameters. A param-based alternative to the '/filter' POST endpoint.
Get Organisations Filtered and Paged (GET)
Retrieves a paged, optionally filtered list of existing organisations using individual query parameters.
A developer calls this endpoint to search for organisations matching one or more criteria (for example by name, relation type, or address), or to retrieve the full set of organisations 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/organisations/filter).
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
pageSize | integer, 1 to 1000 | Optional | The number of organisations 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 organisation's name. |
reference | string | Optional | Filters on the organisation's internal identifier (Reference/Code). |
externalIdentifier | string | Optional | Filters on the organisation's external API identifier. |
relationTypeName | string | Optional | Filters on the relation type assigned to the organisation. |
phoneNumber | string | Optional | Filters on the organisation's landline phone number. |
mobileNumber | string | Optional | Filters on the organisation's mobile phone number. |
primaryEmailAddresses | string | Optional | Filters on the organisation's primary email address(es). |
addressStreetAndHouseNumber | string | Optional | Filters on the combined street and house number of the organisation's address. |
addressPostalCode | string | Optional | Filters on the postal code of the organisation's address. |
addressCity | string | Optional | Filters on the city of the organisation's address. |
addressCountryISOCode | string | Optional | Filters on the ISO 3166-1 alpha-2 country code of the organisation'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. |
organisations | array of objects, nullable | Optional | The list of organisations matching the filter for this page. See sub-fields below. |
organisations.name | string, nullable | Optional | The organisation's registered or trading name. |
organisations.reference | string, nullable | Optional | The internal identifier (Reference/Code) of the organisation. |
organisations.externalIdentifier | string, nullable | Optional | The external API identifier of the organisation, if any. |
organisations.relationTypeName | string, nullable | Optional | The relation type assigned to the organisation. |
organisations.phoneNumber | string, nullable | Optional | The organisation's landline phone number. |
organisations.mobileNumber | string, nullable | Optional | The organisation's mobile phone number. |
organisations.primaryEmailAddresses | string, nullable | Optional | The organisation's primary email address(es). Assumed formatted as a single semicolon-separated string, following the pattern confirmed for the Person search result; to be confirmed for Organisation specifically. |
organisations.addressStreetAndHouseNumber | string, nullable | Optional | The combined street and house number of the organisation's address, for example "Bredaseweg 12". |
organisations.addressPostalCode | string, nullable | Optional | The postal code of the organisation's address. |
organisations.addressCity | string, nullable | Optional | The city of the organisation's address. |
organisations.addressCountryISOCode | string, nullable | Optional | The ISO 3166-1 alpha-2 country code of the organisation's address. |
organisations.archiveDate | string (date-time), nullable | Optional | The date and time from which the organisation is archived, formatted as ISO 8601. Null if not archived. |
organisations.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 organisation.
Optional filter on the reference of the organisation.
Optional filter on the external API identifier of the organisation.
Optional filter on the relation type name of the organisation.
Optional filter on the phone number of the organisation.
Optional filter on the mobile number of the organisation.
Optional filter on the primary e-mail addressess of the organisation.
Optional filter on the street and house number of the address of the organisation.
Optional filter on the postal code of the address of the organisation.
Optional filter on the city of the address of the organisation.
Optional filter on the country ISO code of the address of the organisation.
OK
Ascending = 0 Descending = 1