Search business users

QA Environment

https://qa-api.kiolinkapp.com

GET

/v1/businessusers/search/{query}

Business Users

Last modified:2026-10-05 20:38:24

Maintainer:Not configured

Required Permission(s):tools-businessusers-searchbusiness-users-read

Returns up to 10 active business users whose full name matches any word of query, or whose email contains query (case-sensitive). Business users only find users of their own business.

Requires a session token whose role has any of these permissions: tools-businessusers-search, business-users-read.

Request

Authorization

API Key

Add parameter in header

authorization

Example:

authorization: ********************

Path Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://qa-api.kiolinkapp.com/v1/businessusers/search/ana lopez' \
--header 'authorization: <api-key>'

Responses

🟢200Matching users

application/json

Matching users.

Bodyapplication/json

Example

{
    "data": [
        {
            "_id": "65f1c2a9e4b0a1b2c3d4e5f6",
            "fullname": "Ana López",
            "firstname": "Ana",
            "lastname": "López",
            "email": "ana.lopez@example.com",
            "active": true,
            "business": {
                "name": "Digital Ignition"
            }
        }
    ]
}

🟠401The session token expired

🟠403Not authenticated (missing/invalid token, inactive user), or

🔴500Unexpected error (e

Modified at 2026-10-05 20:38:24

Deactivate business users

Search a business's users