Random Business PartnersDeprecated

Get random Business Partners from this storage.

SecurityapiKey
Request
path Parameters
storageId
required
string (BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6
query Parameters
countryCode
string (CountryShortName)

Country code (ISO 3166-1 alpha-2) used to filter the result of business partners returned.

Example: countryCode=CH
dataSource
string (BusinessPartnerDataSource)

Data Source (name or ID) to be measured during calculating statistics. By default, all Data Sources are measured.

Example: dataSource="CUSTOM_DATA_SOURCE" or "648824a691d8d2503d65103e"
featureOff
Array of strings (FetchBusinessPartnerFeatureParam)

Features to be excluded during the fetch Business Partner.

Items Enum: Description
FETCH_RECORD

Allows to switch fetching record field to reduce data size. By default, turned on.

FETCH_RELATIONS

Allows to switch fetching relations of Business Partners. By default, deactivated. Only for storages with RELATIONS feature activated.

Example: featureOff=FETCH_RECORD
featureOn
Array of strings (FetchBusinessPartnerFeatureParam)

Features to be used during the fetch Business Partner.

Items Enum: Description
FETCH_RECORD

Allows to switch fetching record field to reduce data size. By default, turned on.

FETCH_RELATIONS

Allows to switch fetching relations of Business Partners. By default, deactivated. Only for storages with RELATIONS feature activated.

Example: featureOn=FETCH_RECORD
limit
integer <int32> [ 1 .. 10 ]
Default: 1

Number of items to be returned on the page.

Example: limit=5
modifiedAfter
string

Return entries which were modified after given data. The given date should support ISO-8601 representation.

Example: modifiedAfter=2025-06-04T12:42:19Z
modifiedBefore
string

Return entries which were modified before given data. The given date should support ISO-8601 representation.

Example: modifiedBefore=2025-06-04T12:42:19Z
Responses
200

OK

401

Unauthorized

403

Forbidden

get/v4/storages/{storageId}/businesspartners/random
Request samples
Response samples
application/json
{
  • "limit": "100",
  • "values": [
    ]
}