API: Get Clients Credits

getClientCredits

Get a paginated listing of clients credits

TIP

This API call uses pagination for results.

Optional parameters

Parameter	Description
brand_id	Limit results to certain brand id (for multibrand environment)
amount	Limit results to certain credit amount
amount_operator	If amount is present, set comparison operator, one of: higher, lower, equal

Request

GET /admin/api.php?api_id=API_ID&api_key=API_KEY&call=getClientCredits

PHP Samples

PHP Samples: Limit results to main brand

PHP Samples: Limit results to credit > 10

Response

{
    "success": true,
    "client_credits": [
        {
            "id": "1978",
            "firstname": "Joesph",
            "lastname": "Gerhold",
            "companyname": "fafafaf1234",
            "credit": "0.00",
            "currency_id": "0",
            "brand_id": "2"
        },
        {
            "id": "1975",
            "firstname": "Dameon",
            "lastname": "Fahey",
            "companyname": "",
            "credit": "0.30",
            "currency_id": "0",
            "brand_id": "1"
        },
        {
            "id": "1974",
            "firstname": "Holly",
            "lastname": "Durgan",
            "companyname": "",
            "credit": "2.00",
            "currency_id": "0",
            "brand_id": "2"
        },
        {
            "id": "1973",
            "firstname": "Emma",
            "lastname": "Blick",
            "companyname": "",
            "credit": "0.00",
            "currency_id": "1",
            "brand_id": "1"
        },
        {
            "id": "1972",
            "firstname": "Lois",
            "lastname": "Hartmann",
            "companyname": "Claude_Kunze-Willms76",
            "credit": "0.00",
            "currency_id": "0",
            "brand_id": "1"
        },
        {
            "id": "1971",
            "firstname": "Durward",
            "lastname": "Predovic",
            "companyname": "",
            "credit": "0.00",
            "currency_id": "0",
            "brand_id": "1"
        },
        {
            "id": "475",
            "firstname": "John",
            "lastname": "John",
            "companyname": "test",
            "credit": "0.00",
            "currency_id": "0",
            "brand_id": "1"
        },
        {
            "id": "470",
            "firstname": "Adan",
            "lastname": "Test",
            "companyname": "",
            "credit": "0.00",
            "currency_id": "6",
            "brand_id": "1"
        },
        {
            "id": "469",
            "firstname": "Dillon",
            "lastname": "Denesik",
            "companyname": "",
            "credit": "0.00",
            "currency_id": "0",
            "brand_id": "1"
        },
        {
            "id": "468",
            "firstname": "Mike",
            "lastname": "Denesik",
            "companyname": "",
            "credit": "0.00",
            "currency_id": "1",
            "brand_id": "1"
        }
    ],
    "call": "getClientCredits",
    "sorter": {
        "perpage": 10,
        "totalpages": 22,
        "sorterrecords": "214",
        "sorterpage": 1
    },
    "server_time": 1726471461
}