List external users

QA Environment

https://qa-api.kiolinkapp.com

GET

/v1/kiolink/external-user/list

External Users

Last modified:2026-10-05 21:09:17

Maintainer:Not configured

Required Permission(s):kiolink-externaluser-read

Returns external users sorted by name, with their name, email, company and phone. Returns at most 100 users per request.

Requires a session token whose role has the kiolink-externaluser-read permission.

Request

Authorization

API Key

Add parameter in header

authorization

Example:

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

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://qa-api.kiolinkapp.com/v1/kiolink/external-user/list?skip=0&limit=20' \
--header 'authorization: <api-key>'

Responses

🟢200A page of external users

application/json

A page of external users.

Bodyapplication/json

Example

{
    "total": 1,
    "data": [
        {
            "_id": "65f1c2a9e4b0a1b2c3d4e5f1",
            "name": "Carlos Ruiz",
            "email": "carlos.ruiz@proveedor.com",
            "company": "Proveedor SA de CV",
            "cel": "5512345678"
        }
    ],
    "length": 1
}

🟠401The session token expired

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

🔴500Unexpected error

Modified at 2026-10-05 21:09:17

Overview

Find external users to invite