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
}

Changes

Changed in 19 of the 56 revisions of this API.11922

Jul 27, 2026c9a3573a53971See the full diff
- ○
  added the new optional query request parameter language
  new-optional-request-parameter
Jul 23, 2026afc89996cbbc2See the full diff
- ○
  added the optional property items/items/lastAcceptedAgbDate to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/items/lastAcceptedAgbRevisionId to the response with the 200 status
  response-optional-property-added
Jul 9, 202673b93bab6c7b2See the full diff
- ●
  removed the optional property items/items/lastAcceptedAgbDate from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items/items/lastAcceptedAgbRevisionId from the response with the 200 status
  response-optional-property-removed
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 8, 20264f907e1764812See the full diff
- ○
  added the optional property items/items/lastAcceptedAgbDate to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/items/lastAcceptedAgbRevisionId to the response with the 200 status
  response-optional-property-added
Jun 19, 2026a3a5891898921See the full diff
- ○
  added the optional property items/items/mobileNumber to the response with the 200 status
  response-optional-property-added
Jun 4, 2026d1729646b7662See the full diff
- ●
  added the new DATA_PROVIDER_ERROR enum value to the type response property for the response status 404
  response-property-enum-value-added
- ●
  added the new DATA_PROVIDER_ERROR enum value to the type response property for the response status 500
  response-property-enum-value-added
May 29, 2026a598446f80932See the full diff
- ○
  removed the DATA_PROVIDER_ERROR enum value from the type response property for the response status 404
  response-property-enum-value-removed
- ○
  removed the DATA_PROVIDER_ERROR enum value from the type response property for the response status 500
  response-property-enum-value-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 26, 20267cee7b14bf6f2See the full diff
- ●
  added the new DATA_PROVIDER_ERROR enum value to the type response property for the response status 404
  response-property-enum-value-added
- ●
  added the new DATA_PROVIDER_ERROR enum value to the type response property for the response status 500
  response-property-enum-value-added
May 12, 20265b038eea902d8See the full diff
- ●
  added the new OTP_EXPIRED enum value to the type response property for the response status 404
  response-property-enum-value-added
- ●
  added the new OTP_EXPIRED enum value to the type response property for the response status 500
  response-property-enum-value-added
- ●
  added the new OTP_INVALID enum value to the type response property for the response status 404
  response-property-enum-value-added
- ●
  added the new OTP_INVALID enum value to the type response property for the response status 500
  response-property-enum-value-added
- ●
  added the new OTP_LOCKED enum value to the type response property for the response status 404
  response-property-enum-value-added
- ●
  added the new OTP_LOCKED enum value to the type response property for the response status 500
  response-property-enum-value-added
- ●
  added the new OTP_RESEND_COOLDOWN enum value to the type response property for the response status 404
  response-property-enum-value-added
- ●
  added the new OTP_RESEND_COOLDOWN enum value to the type response property for the response status 500
  response-property-enum-value-added
Mar 20, 20260734563de56e1See the full diff
- ○
  added the optional property items/items/userId to the response with the 200 status
  response-optional-property-added

Full history (19 revisions)