Skip to main content
GET
/
user
/
search
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": "perceval@kaamelott.com",
      "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
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://developers.partoo.co/llms.txt

Use this file to discover all available pages before exploring further.

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

​
email
string<email>

Filter by user email. Value must be a valid email address. Case-insensitive exact match.

​
org_id
integer

Filter by organization ID. Only PROVIDER users can use this filter. If you are not a PROVIDER, this will default to the ID of your organization.

​
query
string

Fuzzy search across the full name and email of users. Case-insensitive.

​
status
enum<string>

Filter users by status

Available options:
active,
invited
Example:

"active"

​
disabled
boolean

If true, return only disabled users. If false, return only active users.

​
has_assigned_businesses
boolean

Filter users based on whether they have at least one assigned business (true) or no assigned businesses (false).

​
has_not_permission
string

Filter users who do not have the specified permission.

For available permissions and their names, use GET /api/v2/permissions to retrieve the full list of available permissions for your organization.

​
has_permission
string

Filter users who have the specified permission.

For available permissions and their names, use GET /api/v2/permissions to retrieve the full list of available permissions for your organization.

​
last_name
string

Filter users by last name (exact substring match, case-sensitive).

​
role
enum<string>

Filter users by role. Accepts a single value or a comma-separated list.

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

"BUSINESS_MANAGER"

​
display_business_ids
boolean
default:true
  • 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.

​
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. Any value lower than 1 will be considered as 1. For the number of items per page, see the per_page query parameter.

​
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,
group_id,
id,
last_activity_date,
last_name,
org_id,
role,
status,
-email,
-first_name,
-group_id,
-id,
-last_activity_date,
-last_name,
-org_id,
-role,
-status

Response

OK

​
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