WhiteLabel API
Clients
List Clients
this endpoint ( get get ) retrieves all your clients the response is paginated; therefore, you should use the 'page' parameter for navigating through the results in subsequent requests on successful completion, it returns an array of client object docid\ qawssttug2rek3psiohv5 the number of available results and the flags used for filtering permissions clients view query parameters page fetch the results from a specific page it defaults to 1 per page the number of results to fetch per page the maximum is 50 and if it defaults to 10 from appendix docid\ kfbmx4q3dxjtduqf75yx1 start date used for filtering to appendix docid\ kfbmx4q3dxjtduqf75yx1 end date used for filtering countries ( appendix docid\ kfbmx4q3dxjtduqf75yx1 ) ( example ?countries=de,ro ) a list of country codes to use for filtering product id filter clients by billing plan order determines in which order the results are returned the available options are asc (ascending) and desc (descending) the default value is desc require "uri" require "net/http" url = uri("https //api tamio com/v2/clients/list?page=1\&per page=10") https = net http new(url host, url port) https use ssl = true request = net http get new(url) request\["accept"] = "application/json" request\["authorization"] = "bearer your token here" response = https request(request) puts response read body curl location request get 'https //api tamio com/v2/clients/list?page=1\&per page=10' \\ \ header 'accept application/json' \\ \ header 'authorization bearer your token here'var myheaders = new headers(); myheaders append("accept", "application/json"); myheaders append("authorization", "bearer your token here"); var requestoptions = { method 'get', headers myheaders, redirect 'follow' }; fetch("https //api tamio com/v2/clients/list?page=1\&per page=10", requestoptions) then(response => response text()) then(result => console log(result)) catch(error => console log('error', error));{ "clients" \[ { "customer id" "69ba5c0a 49c2 4e1d a4a8 e3f3619f1c29", "quotas" { "used storage" 0, "storage quota" 3221225472, "datatransfer quota" 2147483648, "used datatransfer" 0, "automations quota" 0, "used automations" 0, "transaction quota" 12, "used transactions" 0, "products quota" 12, "used products" 0, "languages quota" 2, "used languages" 1, "paid extra languages" 0, "domains quota" 1, "currencies quota" 2, "paid extra currencies" 0, "used currencies" 1, "used domains" 0, "paid extra domains" 0, "teammates quota" 1, "used teammates" 0, "api quota" 0, "used api" 0, "newsletters quota" 12, "used newsletters" 0, "ai quota" 0 }, "is demo" false, "is suspended" false, "permissions" { "account" { "view" true, "edit" true, "remove" true }, "billing" { "view" true, "edit" true }, "keys" { "view" true, "edit" true, "remove" true, "create" true }, "webhooks" { "view" true, "edit" true, "remove" true, "create" true }, "logs" { "view" true }, "audit trail" { "view" true }, "revenue analytics" { "view" true }, "source analytics" { "view" true }, "visitor analytics" { "view" true }, "domains" { "edit" true, "view" true, "create" true, "remove" true }, "taxes" { "edit" true, "view" true, "create" true, "remove" true }, "teammates" { "edit" true, "view" true, "create" true, "remove" true }, "reports" { "view" true, "edit" true }, "sites" { "edit" true, "view" true, "create" true, "remove" true, "publish" true }, "pages" { "edit" true, "view" true, "create" true, "remove" true }, "affiliate programs" { "edit" true, "view" true, "create" true, "remove" true }, "affiliates" { "edit" true, "view" true, "remove" true }, "payouts" { "edit" true, "view" true, "create" true, "remove" true }, "affiliate network" { "edit" true, "view" true }, "payments" { "edit" true, "view" true, "remove" true }, "integrations" { "edit" true, "create" true, "publish" true, "view" true, "remove" true }, "invoices" { "view" true, "edit" true, "remove" true, "create" true }, "subscriptions" { "view" true, "edit" true, "remove" true }, "instalment plans" { "view" true, "edit" true, "remove" true }, "customers" { "view" true, "edit" true, "create" true, "remove" true }, "subscribers" { "view" true, "edit" true, "create" true, "remove" true }, "mailing lists" { "view" true, "edit" true, "create" true, "remove" true }, "automations" { "view" true, "edit" true, "create" true, "remove" true }, "discounts" { "view" true, "edit" true, "create" true, "remove" true }, "email templates" { "view" true, "edit" true, "create" true, "remove" true }, "reviews" { "view" true, "edit" true, "remove" true }, "assets" { "view" true, "edit" true, "create" true, "remove" true }, "products" { "view" true, "edit" true, "create" true, "remove" true }, "shippings" { "view" true, "edit" true, "create" true, "remove" true }, "warehouses" { "view" true, "edit" true, "create" true, "remove" true }, "support" { "view" true, "edit" true, "create" true, "remove" true }, "clients" { "view" true, "edit" true, "create" true, "remove" true }, "agency billing plans" { "view" true, "edit" true, "create" true, "remove" true } }, "status" "active", "billing plan" null, "id" "7ea9c22d 0bd5 4a29 9753 ae210cba77e4", "email" "james\@example com", "registration date" 1681899665, "locale" "en", "country" "de", "name" "james", "business information" { "name" "james", "country" "de", "email" "james\@example com", "currencies" \[ "eur" ], "default currency" "eur", "languages" \[ "en" ], "logos" {}, "facebook" null, "instagram" null, "twitter" null, "pinterest" null } } ], "total results" 1, "status" 200, "page" 1, "per page" 10, "filter" null, "from" null, "to" null }