Search for users

curl --request GET \
  --url https://api.partoo.co/v2/user/search \
  --header 'x-APIKey: <api-key>'

{
  "page": 1,
  "max_page": 10,
  "count": 287,
  "users": [
    {
      "id": "5309c3a237bbc544d8e26737",
      "org_id": 42,
      "first_name": "Perceval",
      "last_name": "de Galles",
      "email": "[email protected]",
      "lang": "fr",
      "phone": "<string>",
      "sidebar_pages": [
        "bulk_modification"
      ],
      "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
    }
  ]
}

GET

user

Search for users

curl --request GET \
  --url https://api.partoo.co/v2/user/search \
  --header 'x-APIKey: <api-key>'

{
  "page": 1,
  "max_page": 10,
  "count": 287,
  "users": [
    {
      "id": "5309c3a237bbc544d8e26737",
      "org_id": 42,
      "first_name": "Perceval",
      "last_name": "de Galles",
      "email": "[email protected]",
      "lang": "fr",
      "phone": "<string>",
      "sidebar_pages": [
        "bulk_modification"
      ],
      "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.

Query Parameters

string<email>

Filter by email

org_id

integer

Filter by org id

query

string

To perform a fuzzy search on user

status

enum<string>

Filter users by status User status in the application

Available options:

active,

invited

Example:

"active"

disabled

boolean

Filter by disabled users

display_business_ids

enum<string>

default:True

The endpoint won’t return the business_ids when the value is False

Available options:

True,

False

business_id

string

Filter by users having access to the business with the provided id.

Example:

"5409c35a97bbc544d8e26737u"

page

integer

default:1

Page number, Starts at 1. From 1 to 100 results per page (see per_page)

per_page

integer

default:30

Number of items to return per page. Currently limited to 100.

Required range: 1 <= x <= 100

order_by

enum<string>

default:id

Order result by given attribute. Reverse order can as well be obtained by using a - (minus sign) before the attribute name, e.g. order_by=-name

Available options:

email,

first_name,

last_name,

role,

org_id,

group_id,

status,

-email,

-first_name,

-last_name,

-role,

-org_id,

-group_id,

-status

Response

page

integer

Current page number

Example:

1

max_page

integer

Last page number

Example:

10

count

integer

Number of resources complying with filters

Example:

287

users

object[]

List of users

Show child attributes

users.id

string

User id

Example:

"5309c3a237bbc544d8e26737"

users.org_id

integer

User organization id

Example:

42

users.first_name

string

User first name

Example:

"Perceval"

users.last_name

string

User last name

Example:

"de Galles"

users.email

string<email>

User email

Example:

"[email protected]"

users.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"

users.phone

string

User phone number

users.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

users.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

users.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]]

users.role

enum<string>

User role in the application

Available options:

PROVIDER,

ORG_ADMIN,

ORG_MANAGER,

GROUP_MANAGER,

BUSINESS_MANAGER,

PUBLISHER

Example:

"BUSINESS_MANAGER"

users.provider

string

User provider label

Example:

"partoo"

users.status

enum<string>

User status in the application

Available options:

active,

invited

Example:

"active"

users.disabled

boolean

The state of the User account.

Example:

false

users.keywords

string[]

Array of keywords

Maximum array length: 12

users.created_at

number

Timestamp representing the date the user was created

Example:

1615299414

users.shadow_user_id

string

Used internally at Partoo

Example:

""

users.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"

users.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.

Update business's plans My user

ApiKeys

Businesses

Business Fields

Categories

Connection Tokens

Messages

Custom Channels

Message Reply Templates

Messaging Settings

Custom Fields

Custom Fields Section

Custom Roles

Google

Groups and Sections

Holidays

Organizations

Posts

Place Action Links

Presence

Reviews

Presence analytics

Review analytics

Review Booster

Subscriptions

Users

Feedback Management

Webhooks

Webhooks Events

Search for users

Authorizations

Query Parameters

Response