v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-306170167.5 KB

Users

Get Producers

Retrieves users matching the given query parameters.

get/api/user/v1/producers

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

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": [
    {
      "agateLoginId": "1234567",
      "ktIdP": "ZH123456",
      "uid": "CHE123456789",
      "givenName": "Anna",
      "familyName": "Muster",
      "email": "anna.muster@example.com",
      "phoneNumber": "+41331234567",
      "mobileNumber": "+41791234567",
      "addressStreet": "Bahnhofstrasse 10",
      "addressLocality": "Zürich",
      "addressPostalCode": "8001",
      "addressCountry": "CH",
      "lastLoginDate": "2022-03-10T12:15:50",
      "userPreferences": {
        "mainMenuOpened": true,
        "activeUid": "CHE123456789",
        "dismissedMigratedIds": [
          "a5b1d2e3-4f6a-2b7c-6d0e-9f1a3b5c7d9e"
        ],
        "hasSeenConsentRequestTourIntro": true
      },
      "lastAcceptedAgbDate": "2022-03-10T12:15:50"
    }
  ],
  "totalItems": 42,
  "totalPages": 5,
  "currentPage": 1,
  "pageSize": 10
}