List businesses

GET

https://api.staging.vrtx.sa/cl/v1/businesses

Last modified:2025-12-03 07:59:44

Retrieve all businesses that the closed-loop orchestrator manages.
This endpoint lists every business entity registered within the ecosystem, including their operational accounts and core metadata.

It supports pagination and can be filtered by status.
If no filters are applied, it returns all active and inactive businesses in the system (paginated).

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.staging.vrtx.sa/cl/v1/businesses?status=ACTIVE&limit=50&cursor=eyJvZmZzZXQiOiI4NGFmIn0=' \
--header 'Authorization: Bearer <token>'

Responses

🟢200OK

application/json

Body

Example

{
    "items": [
        {
            "id": "84a86c0f-39bb-41e6-a531-7065a32b990a",
            "unified_number": "7000182993",
            "cr_number": "1234567895",
            "official_name_ar": "شركة فرتكس العربية",
            "official_name_en": "Vrtx Arabia Trading Co.",
            "short_name_ar": "فرتكس العربية",
            "short_name_en": "Vrtx KSA",
            "cr_expiry_date": "2025-12-31T00:00:00.000Z",
            "email": "ops@vrtx.sa",
            "mobile": "+966501234567",
            "prefix3": "092",
            "account_number": "009200005016",
            "status": "ACTIVE",
            "created_at": "2025-10-25T11:02:50.415Z",
            "updated_at": "2025-10-25T11:02:50.415Z"
        },
        {
            "id": "9fa5cea8-6edb-4196-800f-8809e08f1365",
            "unified_number": "7008282993",
            "cr_number": "1010456792",
            "official_name_ar": "شركة فرتكس العربية",
            "official_name_en": "Vrtx Arabia Trading Co.",
            "short_name_ar": "فرتكس العربية",
            "short_name_en": "Vrtx KSA",
            "cr_expiry_date": "2025-12-31T00:00:00.000Z",
            "email": "ops@vrtx.sa",
            "mobile": "+966501234567",
            "prefix3": "998",
            "account_number": "099800003024",
            "status": "ACTIVE",
            "created_at": "2025-10-25T07:21:02.725Z",
            "updated_at": "2025-10-25T07:21:02.725Z"
        },
        {
            "id": "2bb58ca6-1b9a-47b4-ab4d-b2996f0498f3",
            "unified_number": "7628282993",
            "cr_number": "1234567891",
            "official_name_ar": "شركة الاختبار المحدودة",
            "official_name_en": "Testing Company LLC",
            "short_name_ar": "التجريبية",
            "short_name_en": "Test Co.",
            "cr_expiry_date": "2025-12-31T00:00:00.000Z",
            "email": "ops@test.sa",
            "mobile": "+966501234567",
            "prefix3": "542",
            "account_number": "054200001011",
            "status": "ACTIVE",
            "created_at": "2025-10-25T05:37:30.532Z",
            "updated_at": "2025-10-25T05:37:30.532Z"
        },
        {
            "id": "9bca8aba-99b6-41c2-8f1e-55c96fcb38d2",
            "unified_number": "7123456787",
            "cr_number": "1234567890",
            "official_name_ar": "شركة فرتكس العربية",
            "official_name_en": "Vrtx Arabia Trading Co.",
            "short_name_ar": "فرتكس العربية",
            "short_name_en": "Vrtx KSA",
            "cr_expiry_date": "2026-12-31T00:00:00.000Z",
            "email": "ops@vrtx.sa",
            "mobile": "+966501234567",
            "prefix3": "137",
            "account_number": "013700000014",
            "status": "ACTIVE",
            "created_at": "2025-10-25T05:11:02.839Z",
            "updated_at": "2025-10-25T05:11:02.839Z"
        }
    ],
    "next_cursor": "MjAyNS0xMC0yNVQwNToxMTowMi44Mzk5NTdafDliY2E4YWJhLTk5YjYtNDFjMi04ZjFlLTU1Yzk2ZmNiMzhkMg",
    "has_next": false
}

🟠401Unauthorized

🟠403Forbidden

Modified at 2025-12-03 07:59:44

Token

Create business