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