List labels

GET

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

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

Return all labels available in the closed-loop ecosystem.

Developers can use this endpoint to retrieve all predefined labels configured within the system or per business.

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/labels?business_id=2bb58ca6-1b9a-47b4-ab4d-b2996f0498f3&limit=50&cursor=MjAyNS0xMC0yNVQwNjo1ODozMi45MTg2NzdafDVhMzZjNzRhLWU0NzktNDNjZC1hNDIwLWZiNzJhNTkxZDNlNg' \
--header 'Authorization: Bearer <token>'

Responses

🟢200OK

application/json

Body

Example

{
    "items": [
        {
            "id": "fb6905f8-83a5-4953-bbe6-0bbad32f873d",
            "business_id": "2bb58ca6-1b9a-47b4-ab4d-b2996f0498f3",
            "name": "Revenue Wallet - محفظة الأرباح",
            "created_at": "2025-10-25T09:10:58.202Z"
        },
        {
            "id": "5a36c74a-e479-43cd-a420-fb72a591d3e6",
            "business_id": "2bb58ca6-1b9a-47b4-ab4d-b2996f0498f3",
            "name": "Merchant Wallet - محفظة التاجر",
            "created_at": "2025-10-25T06:58:32.918Z"
        }
    ],
    "next_cursor": "MjAyNS0xMC0yNVQwNjo1ODozMi45MTg2NzdafDVhMzZjNzRhLWU0NzktNDNjZC1hNDIwLWZiNzJhNTkxZDNlNg",
    "has_next": false
}

🟠401Unauthorized

🟠403Forbidden

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

Create withdrawal

Create label