> ## 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 organisations filtered and paged > Get a paged list of existing organisations, optionally filtered to the given parameters. A param-based alternative to the '/filter' POST endpoint. ## OpenAPI ````json GET /api/v1/relations/organisations/filter { "openapi": "3.0.4", "info": { "title": "Relations V1", "description": "# Relation API Documentation\n\nWelcome to the Relationship Management API documentation. This API allows you to perform CRUD operations on various relationship types, including Owners, Persons, Suppliers, Estate Agents, and Organisations. \n\n## Authentication \n\nTo access the API, include your API key in the headers. Refer to our authentication documentation for details on obtaining and using your API key. \n\n## CRUD Operations \n\nThe API supports CRUD operations for the following relationship types: \n\n- **Owners**\n- **Persons**\n- **Suppliers**\n- **Estate Agents**\n- **Organisations**\n\nFor each relationship type, you can: \n\n- **GET**: Retrieve a list or apply filters.\n- **POST**: Add a new entry.\n- **PUT**: Update existing details.\n- **PATCH**: Apply partial updates.\n- **DELETE**: Remove an entry.\n\nThank you for choosing our Relation API. If you have any questions or need assistance, please contact our support team. \n", "version": "v1" }, "security": [ {} ], "tags": [ { "name": "Common" }, { "name": "CommunicationFormAPI" }, { "name": "EstateAgentAPI" }, { "name": "Metadata" }, { "name": "OrganisationAPI" }, { "name": "OwnerAPI" }, { "name": "PersonAPI" }, { "name": "RelationTypeAPI" }, { "name": "SupplierAPI" }, { "name": "SupplierTypeAPI" } ], "paths": { "/api/v1/relations/organisations/filter": { "get": { "tags": [ "Relations" ], "summary": "Get organisations filtered and paged", "description": "Get a paged list of existing organisations, optionally filtered to the given parameters. A param-based alternative to the '/filter' POST endpoint.", "operationId": "GetOrganisationsFilteredPaged_Alt", "parameters": [ { "name": "pageSize", "in": "query", "description": "The requested page size. Defaults to 100 when not given.", "schema": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "description": "The requested page number. Defaults to 1 when not given.", "schema": { "maximum": 9999, "minimum": 1, "type": "integer", "format": "int32" } }, { "name": "name", "in": "query", "description": "Optional filter on the name of the organisation.", "schema": { "type": "string" } }, { "name": "reference", "in": "query", "description": "Optional filter on the reference of the organisation.", "schema": { "type": "string" } }, { "name": "externalIdentifier", "in": "query", "description": "Optional filter on the external API identifier of the organisation.", "schema": { "type": "string" } }, { "name": "relationTypeName", "in": "query", "description": "Optional filter on the relation type name of the organisation.", "schema": { "type": "string" } }, { "name": "phoneNumber", "in": "query", "description": "Optional filter on the phone number of the organisation.", "schema": { "type": "string" } }, { "name": "mobileNumber", "in": "query", "description": "Optional filter on the mobile number of the organisation.", "schema": { "type": "string" } }, { "name": "primaryEmailAddresses", "in": "query", "description": "Optional filter on the primary e-mail addressess of the organisation.", "schema": { "type": "string" } }, { "name": "addressStreetAndHouseNumber", "in": "query", "description": "Optional filter on the street and house number of the address of the organisation.", "schema": { "type": "string" } }, { "name": "addressPostalCode", "in": "query", "description": "Optional filter on the postal code of the address of the organisation.", "schema": { "type": "string" } }, { "name": "addressCity", "in": "query", "description": "Optional filter on the city of the address of the organisation.", "schema": { "type": "string" } }, { "name": "addressCountryISOCode", "in": "query", "description": "Optional filter on the country ISO code of the address of the organisation.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganisationSearchResult" } } } } }, "x-d360-narrative-url": "

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.

" } } }, "components": { "schemas": { "OrganisationSearchResult": { "type": "object", "properties": { "paging": { "$ref": "#/components/schemas/PagingInfo" }, "sorting": { "$ref": "#/components/schemas/SortingInfo" }, "organisations": { "type": "array", "items": { "$ref": "#/components/schemas/OrganisationSearchResultFilter" }, "nullable": true } }, "additionalProperties": false }, "PagingInfo": { "type": "object", "properties": { "pageSize": { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "nullable": true }, "pageNumber": { "maximum": 9999, "minimum": 1, "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "SortingInfo": { "type": "object", "properties": { "columnName": { "type": "string", "nullable": true }, "order": { "type": "integer", "description": "Ascending = 0\nDescending = 1", "format": "int32", "x-enumNames": [ "Ascending", "Descending" ] } }, "additionalProperties": false }, "OrganisationSearchResultFilter": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "reference": { "type": "string", "nullable": true }, "externalIdentifier": { "type": "string", "nullable": true }, "relationTypeName": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "mobileNumber": { "type": "string", "nullable": true }, "primaryEmailAddresses": { "type": "string", "nullable": true }, "addressStreetAndHouseNumber": { "type": "string", "nullable": true }, "addressPostalCode": { "type": "string", "nullable": true }, "addressCity": { "type": "string", "nullable": true }, "addressCountryISOCode": { "type": "string", "nullable": true }, "archiveDate": { "type": "string", "format": "date-time", "nullable": true }, "lastModified": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false } } } } ````