Get Data Products Paginated

Retrieves a paginated list of all available data products. Accessible to users with the producer, and admin. Supports pagination.

get/api/products/v2

Query parameters

languagestring

language code for multilingual fields. Must be supported by application.

pageinteger

page number

searchTermstring

string to search for in the resource

sizeinteger

page size

sortByobject

List of field names to sort by. Default is ascending prefix with - for descending

actingRole'PROVIDER' | 'ADMIN'

Selects the role in which the authenticated user acts for this request. Optional: if the authenticated user holds exactly one of the allowed roles, the value is auto-resolved. Returns 400 if the value is unknown, not allowed for this endpoint, or omitted while the user holds multiple matching roles. Returns 403 if the user does not hold the role specified in the parameter.

Response

totalItemsinteger required

Total number of items across all pages.

totalPagesinteger required

Total number of pages available.

currentPageinteger required

Current page number (0-based ).

pageSizeinteger required

Number of items per page.

Example response

{
  "items": [
    {
      "dataSourceSystemCode": "AGIS",
      "dataSourceSystem": {
        "code": "AGIS",
        "dataProvider": {
          "code": "BLW",
          "uid": "CHE123456789"
        }
      },
      "restClient": {
        "code": "AGIS_API",
        "displayName": "Agis",
        "url": "http://example.com/agis"
      },
      "deprecatedSince": "2022-03-10T12:15:50",
      "restClientChangeDetectionPathTemplate": "v1/animal-updates/{{uid}}?since={{LAST_CHANGED_SINCE}}",
      "consentRequired": true
    }
  ],
  "totalItems": 42,
  "totalPages": 5,
  "currentPage": 1,
  "pageSize": 10
}

Changes

Changed in 14 of the 56 revisions of this API.1225

Aug 13, 2026a0609096db651See the full diff
- ○
  added the required property items/items/consentRequired to the response with the 200 status
  response-required-property-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 11, 202652c1637abca022See the full diff
- ●
  added the new UNBOUND_BUR_BASED_POST_VALIDATION enum value to the items/items/flowCode response property for the response status 200
  response-property-enum-value-added
- ●
  added the new UNBOUND_UID_BASED_POST_VALIDATION enum value to the items/items/flowCode response property for the response status 200
  response-property-enum-value-added
- ○
  removed the UNBOUND_POST_VALIDATION enum value from the items/items/flowCode response property for the response status 200
  response-property-enum-value-removed
- ○
  added the required property items/items/dataSourceSystem/legalBasis to the response with the 200 status
  response-required-property-added
Jul 27, 2026c9a3573a53971See the full diff
- ○
  added the new optional query request parameter language
  new-optional-request-parameter
Jul 13, 2026bf09fcfe746c11See the full diff
- ●
  removed the optional property items/items/technicalDescription from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property items/items/extendedDescription to the response with the 200 status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 9, 202673b93bab6c7b11See the full diff
- ●
  removed the optional property items/items/extendedDescription from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property items/items/technicalDescription to the response with the 200 status
  response-optional-property-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 8, 20264f907e17648112See the full diff
- ●
  removed the optional property items/items/technicalDescription from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property items/items/extendedDescription to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/items/restClient/displayName to the response with the 200 status
  response-optional-property-added
Jul 6, 2026bfb5aa26b19b2See the full diff
- ○
  added the optional property items/items/links to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/items/technicalDescription to the response with the 200 status
  response-optional-property-added
Jul 2, 2026aec259103b953See the full diff
- ●
  removed the optional property items/items/links from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items/items/restClient/displayName from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items/items/technicalDescription from the response with the 200 status
  response-optional-property-removed
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 2, 202616bdeed9be544See the full diff
- ○
  added the optional property items/items/links to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/items/restClient/displayName to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/items/restClient/url to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/items/technicalDescription to the response with the 200 status
  response-optional-property-added
Jun 19, 2026a3a5891898921See the full diff
- ○
  added the optional property items/items/restClientChangeDetectionPathTemplate to the response with the 200 status
  response-optional-property-added

Full history (14 revisions)