Skip to main content
GET
/
user
/
{user_id}
User information
curl --request GET \
  --url https://api.partoo.co/v2/user/{user_id} \
  --header 'x-APIKey: <api-key>'
{
  "id": "5309c3a237bbc544d8e26737",
  "org_id": 42,
  "first_name": "Perceval",
  "last_name": "de Galles",
  "email": "[email protected]",
  "lang": "fr",
  "phone": "<string>",
  "sidebar_pages": [
    "bulk_modification"
  ],
  "available_features": [
    "diffusion"
  ],
  "business_ids": [
    "5409c35a97bbc544d8e26737"
  ],
  "accesses": [
    [
      1,
      2
    ],
    [
      1,
      3
    ]
  ],
  "role": "BUSINESS_MANAGER",
  "provider": "partoo",
  "status": "active",
  "disabled": false,
  "keywords": [
    "<string>"
  ],
  "created_at": 1615299414,
  "shadow_user_id": "",
  "custom_role": "my_custom_role",
  "sso_only": false
}

Authorizations

​
x-APIKey
string
header
required

The authentication system on Partoo API is using API Key that should be put in the header of the request (the name of the header is x-APIKey). An api_key is linked to a user. This user's role will give you different access level to the API features.

Path Parameters

​
user_id
string
required

User id

Response

OK

Partoo App User

​
id
string

User id

Example:

"5309c3a237bbc544d8e26737"

​
org_id
integer

User organization id

Example:

42

​
first_name
string

User first name

Example:

"Perceval"

​
last_name
string

User last name

Example:

"de Galles"

​
email
string<email>

User email

Example:

"[email protected]"

​
lang
enum<string>

Available language in the application

Available options:
fr,
en,
es,
it,
pt-br,
de,
ar,
nl,
pl,
cs,
ca,
sk,
pt,
lv,
ro,
bg,
hu
Example:

"fr"

​
phone
string

User phone number

​
sidebar_pages
enum<string>[]
deprecated

List of features the user can access from the sidebar.

Sidebar page feature name

Available options:
bulk_modification,
diffusion,
feedback_management,
messages,
posts,
presence_analytics,
review_analytics,
review_invite,
review_management
​
available_features
enum<string>[]

The features the user has access to.

Business feature name

Available options:
diffusion,
feedback_management,
messages,
posts,
review_invite,
review_management
​
business_ids
string[]

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.

Business id

​
accesses
integer[][]

List of (list of Group ID).

Accesses of the users for the new groups system, only for GROUP_MANAGER users.

See the Groups and Sections description

Example:
[[1, 2], [1, 3]]
​
role
enum<string>

User role in the application

Available options:
PROVIDER,
ORG_ADMIN,
ORG_MANAGER,
GROUP_MANAGER,
BUSINESS_MANAGER,
PUBLISHER
Example:

"BUSINESS_MANAGER"

​
provider
string

User provider label

Example:

"partoo"

​
status
enum<string>

User status in the application

Available options:
active,
invited
Example:

"active"

​
disabled
boolean

The state of the User account.

Example:

false

​
keywords
string[]

Array of keywords

Maximum array length: 12
​
created_at
number

Timestamp representing the date the user was created

Example:

1615299414

​
shadow_user_id
string

Used internally at Partoo

Example:

""

​
custom_role
string

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

Example:

"my_custom_role"

​
sso_only
boolean
default:false

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.