Search a business's devices

QA Environment

https://qa-api.kiolinkapp.com

GET

/v1/business/{id}/devices/query

Business Devices

Last modified:2026-10-05 20:36:08

Maintainer:Not configured

Required Permission(s):dcservices-devices-read

Returns up to 10 devices of a business (active or not) whose serial number, brand, model, location or device type name contains query (case-insensitive). Characters other than letters, digits, spaces, - and & are removed from query.

query is required; a missing query results in HTTP 500.

Requires a session token whose role has the dcservices-devices-read permission.

Request

Authorization

API Key

Add parameter in header

authorization

Example:

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

Path Params

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/65f1c2a9e4b0a1b2c3d4e5a1/devices/query?query=SGH123' \
--header 'authorization: <api-key>'

Responses

🟢200Matching devices

application/json

Matching devices.

Bodyapplication/json

Example

{
    "total": 1,
    "data": [
        {
            "_id": "65f1c2a9e4b0a1b2c3d4e5d1",
            "_devicetype": {
                "_id": "65f1c2a9e4b0a1b2c3d4e5d9",
                "name": "Servidor"
            },
            "serie": "SGH123ABC",
            "marca": "HPE",
            "modelo": "ProLiant DL380 Gen10",
            "location": "MEX1",
            "fase": "F1",
            "status": "Ingresado",
            "active": true,
            "details": {
                "rack_gabinete": "R12",
                "num_fuentes": "2",
                "amperes": "4",
                "voltaje": "220"
            },
            "_business": "65f1c2a9e4b0a1b2c3d4e5a1",
            "movement_request": false,
            "historical": [
                {
                    "_id": "65f1c2a9e4b0a1b2c3d4e5d2",
                    "fecha": "2025-03-10T15:20:00.000Z",
                    "prev_status": "Standby",
                    "status": "Ingresado",
                    "datacenter": "MEX1",
                    "fase": "F1",
                    "_user_authorize": {
                        "_id": "65f1c2a9e4b0a1b2c3d4e5e7",
                        "firstname": "José María",
                        "lastname": "Esparza Arévalo",
                        "email": "jose.esparza@digitalignition.com.mx",
                        "avatar": "",
                        "keywe": {}
                    },
                    "_business_user_request": {
                        "_id": "65f1c2a9e4b0a1b2c3d4e5f6",
                        "firstname": "Ana",
                        "lastname": "López",
                        "email": "ana.lopez@example.com",
                        "business": "65f1c2a9e4b0a1b2c3d4e5a1"
                    },
                    "folio_visita": "KL-2025-000123",
                    "isAuto": false
                }
            ],
            "historical_request": [],
            "created_at": "2025-01-15T18:00:00.000Z",
            "owner": "Cliente",
            "transfer_request": false,
            "__v": 0
        }
    ],
    "length": 1
}

🟠401The session token expired

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

🔴500Unexpected error (e

Modified at 2026-10-05 20:36:08

List a business's devices

Export all business devices