Sign in

v1

OpenAPI 3.0.1Proprietary2026-07-146923125.8 KB
User

Retrieve all users

get/user

Query parameters

searchstring

Fuzzy filter by username, name, surname or email

companyIdinteger

Filter by Company ID

rolestring

Filter by User role

disabledboolean

Retrieve only disabled Users

externalAuthenticationboolean

Filter by external authentication

pageNumberinteger

Page number to retrieve

Page number to retrieve

pageSizeinteger

Number of elements for the requested page

Number of elements for the requested page

sortDirection'ASC' | 'DESC'

Elements sort direction

Elements sort direction

sortFieldstring

Field to sort by

Response

OK

idinteger
selfstring
userNamestring required
namestring required

Given name

surnamestring required

Family name

fullNamestring

Concatenation of name and surname

passwordstring

Plain-text password, used only when setting a new password

passwordHashstring

The hashed password, visible to platform administrator only

languagestring

Preferred user language

emailstring required

User email address to receive platform notifications

pecstring

User PEC address for Italian electronic invoicing

phoneNumberstring
userRole'ROLE_ANONYMOUS' | 'ROLE_USER' | 'ROLE_VENDOR' | 'ROLE_RESELLER' | 'ROLE_DISTRIBUTOR' | 'ROLE_SUPERVISOR' | 'ROLE_ADMIN' | 'ROLE_SUPERADMIN' required

Defines user roles across the platform

groupsstring[]
companyNamestring

Write-only field to specify a company name when creating a user with userRole ROLE_VENDOR

companyTaxCodestring

Write-only field to specify a company tax code when creating a user with userRole ROLE_VENDOR

enabledboolean

If the user can login or not

activatedboolean

If the user has a confirmed email address

readOnlyboolean

If the user profile can be updated or is synchronized from an external system

doNotTrackboolean

If the user does not wants to be tracked

acceptedTermsboolean

If the user has accepted terms and conditions

environmentstring

The name of the environment this user belongs to

activationDatestring date-time

When the user has confirmed successfully his email address

creationDatestring date-time

When the user has created his account

externalIdstring

An externalId if the user is synchronized from an external system

keycloakTokenstring

The account id of the user when using the Keycloak SSO integration

keycloakAuthenticatedboolean

If the current user is authenticated via Keycloak SSO integration

fiscalCodestring

Fiscal code of a private customer, used only when userRole is ROLE_USER

ibanstring

IBAN of the user, to receive manually executed refunds

paymentDataSavedboolean

If the user has a valid payment method available

culturestring

String representation of the culture, derived from language and country code

passwordAlreadySetboolean

If the user has a password set

subscribedToNotificationEmailsboolean

If the user want to receive email notifications generated by the platform

deletedboolean

If the user has been deleted

canImpersonatestring[]

What roles can this user impersonate

canCreatestring[]

What roles can this user create

validAddressboolean

If the user has a configured valid address

validBillingDataboolean

If the user has configured valid billing data

publicKeystring

The user's SSH public key

slugstring

Auto-generated string uniquely identifying the user

canBeImpersonatedboolean

Whether the user can be impersonated by the requesting client

Example response

[
  {
    "self": "subscription/123",
    "company": {
      "url": "resourceName/ID"
    },
    "userCompany": {
      "url": "resourceName/ID"
    },
    "companyGroup": {
      "url": "resourceName/ID"
    },
    "culture": "en_US",
    "riskProfile": {
      "url": "resourceName/ID"
    },
    "resellerCatalog": {
      "url": "resourceName/ID"
    },
    "metadata": {
      "url": "resourceName/ID"
    }
  }
]