Skip to main content
GET
/
customers
List Customers
curl --request GET \
  --url https://api.{your-broker}.slate-labs.com/customers
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Query Parameters

​
owner_id
string<uuid> | null
​
unassigned
boolean | null

If true, return only customers with no owner (owner_id IS NULL)

​
country
string[] | null
​
kyc_status_id
integer[] | null
​
sales_status_id
integer[] | null
​
affiliate_id
string | null

contains match

​
campaign_id
string | null

contains match

​
has_ftd
boolean | null
​
is_active
boolean | null
​
retention_status
string | null
​
risk_classification
string | null
​
compliance_status
string | null
​
search
string | null
​
registration_source
string | null

organic / affiliate / import / promo

​
funnel
string | null

contains match

​
promo_code_id
string<uuid> | null
​
last_activity_from
string<date> | null
​
last_activity_to
string<date> | null
​
last_login_from
string<date> | null
​
last_login_to
string<date> | null
​
reg_from
string<date> | null
​
reg_to
string<date> | null
​
ftd_from
string<date> | null
​
ftd_to
string<date> | null
​
page
integer
default:1
Required range: x >= 1
​
page_size
integer
default:50
Required range: 1 <= x <= 500
​
sort_by
string | null
​
sort_dir
string | null
default:desc

Response

Successful Response