List businesses

QA Environment

https://qa-api.kiolinkapp.com

GET

/v1/business

Businesses

Last modified:2026-10-05 20:35:02

Maintainer:Not configured

Required Permission(s):business-business-read

Returns businesses with their name, one-line address, SAP number and phone.

limit is capped at 100: a missing limit, or one greater than 100, returns every business.

Paging (skip/limit) is applied before sorting, so each page is sorted by name but pages are not in global name order.

Requires a session token whose role has the business-business-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/business?skip=0&limit=20&active=1' \
--header 'authorization: <api-key>'

Responses

🟢200A page of businesses

application/json

A page of businesses.

Bodyapplication/json

Example

{
    "total": 1,
    "data": [
        {
            "_id": "65f1c2a9e4b0a1b2c3d4e5a1",
            "name": "Digital Ignition",
            "location": "Av. Prolongación Paseo de la Reforma 5287 Cuajimalpa de Morelos Ciudad de México México C.P. 05000",
            "sap": "100234",
            "tel": "5550000000"
        }
    ],
    "length": 1
}

🟠401The session token expired

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

🔴500Unexpected error

Modified at 2026-10-05 20:35:02

Set a business's report recipients

Search businesses