Sign in

v1

latestOpenAPI 3.1.0© Copyright Partoo2026-07-26163503484.0 KB
Users

User information

This endpoint lets you retrieve all the information on a user. You need to have READ access to this users.

get/user/{user_id}

Path parameters

user_idstring required

User id

Query parameters

display_business_idsboolean
  • If true, response includes business_ids; a list of businesses the user has access to.
  • If false, response does not include business_ids.

⚠️ Note: The business_ids list is only populated for users with the BUSINESS_MANAGER role.

Response

OK

idstring

User id

org_idinteger

User organization id

first_namestring

User first name

last_namestring

User last name

emailstring email

User email

lang'fr' | 'en' | 'es' | 'it' | 'pt-br' | 'de' | 'ar' | 'nl' | 'pl' | 'cs' | 'ca' | 'sk' | 'pt' | 'lv' | 'ro' | 'bg' | 'hu'

Available language in the application

sidebar_pagesSidebarPagesFeatureEnum[]

List of features the user can access from the sidebar.

available_featuresFeature[]

The features the user has access to.

business_idsBusinessId[]

Populated only for BUSINESS_MANAGER role.

List of businesses ids the user can access.

Note: For a reliable way of getting all the businesses the user can access, use operation/searchBusinesses.

role'PROVIDER' | 'ORG_ADMIN' | 'ORG_MANAGER' | 'GROUP_MANAGER' | 'BUSINESS_MANAGER' | 'PUBLISHER'

User role in the application

providerstring

User provider label

status'active' | 'invited'

User status in the application

disabledboolean

The state of the User account.

created_atnumber

Timestamp representing the date the user was created

shadow_user_idstring

Used internally at Partoo

custom_rolestring

Optional API identifier of a custom role to assign to the user. The value must match the api_id of one of the custom roles available to your organization.

If no custom role is given, users with the role GROUP_MANAGER or BUSINESS_MANAGER will automatically be assigned to the default built-in custom role associated with their role.

For more information about custom roles, see Managing User Permissions with Custom Roles

sso_onlyboolean

Prevent the user from connecting directly from the Partoo connection page.

This field is available for users whose organization has defined an SSO configuration.

This field can be edited by a user with the role ORG_ADMIN or PROVIDER.

Example response

{
  "id": "5309c3a237bbc544d8e26737",
  "org_id": 42,
  "first_name": "Perceval",
  "last_name": "de Galles",
  "email": "perceval@kaamelott.com",
  "lang": "fr",
  "business_ids": [
    "5409c35a97bbc544d8e26737"
  ],
  "accesses": [
    [
      1,
      2
    ],
    [
      1,
      3
    ]
  ],
  "role": "BUSINESS_MANAGER",
  "provider": "partoo",
  "status": "active",
  "created_at": 1615299414,
  "custom_role": "my_custom_role"
}