Sign in

v1

latestOpenAPI 3.1.0© Copyright Partoo2026-07-26163503484.0 KB
Users

Search for users

This endpoint lets you search for users using filters

get/user/search

Query parameters

emailstring email

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

org_idinteger

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.

querystring

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

status'active' | 'invited'

User status in the application

Example:active
disabledboolean

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

has_assigned_businessesboolean

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

has_not_permissionstring

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_permissionstring

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_namestring

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

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

User role in the application

Example:BUSINESS_MANAGER
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.

business_idstring

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

Example:5409c35a97bbc544d8e26737u
pageinteger

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_pageinteger

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

order_by'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'

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

Response

OK

pageinteger

Current page number

max_pageinteger

Last page number

countinteger

Number of resources complying with filters

Example response

{
  "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",
      "business_ids": [
        "5409c35a97bbc544d8e26737"
      ],
      "accesses": [
        [
          1,
          2
        ],
        [
          1,
          3
        ]
      ],
      "role": "BUSINESS_MANAGER",
      "provider": "partoo",
      "status": "active",
      "created_at": 1615299414,
      "custom_role": "my_custom_role"
    }
  ]
}