Qodex.ai

Get a list of Customers

GET {{baseUrl}}/customers

Request Params

KeyDatatypeRequiredDescription
uidstringFilter by Customer. Multiple values are allowed e.g. uid[]=uKxmLxUEiSj5h4M3&uid[]=y9reyPMNEWuuYSC1.
statusstringFilter by onboarding status. Please note that the initiated enum value will not be respected unless the include_initiated=true parameter is also provided. Multiple values are allowed e.g. status[]=queued&status[]=active.
include_initiatedbooleanBy default, Customers in initiated status are not shown, even if the status=initiated parameter is provided. In order for Customers with status initiated to appear in search results, parameters must include include_initiated=true
kyc_statusstringFilter by KYC status. Multiple values are allowed e.g. kyc_status[]=approved&kyc_status[]=under_review.
customer_typestringOnly return Customers with a customer type matching exactly what is submitted. Multiple values are allowed e.g. customer_type[]=primary&customer_type[]=secondary.
first_namestringOnly return Customers with a first name matching exactly what is submitted. Multiple values are allowed e.g. first_name[]=Olive&first_name[]=Jack.
last_namestringOnly return Customers with a last name matching exactly what is submitted. Multiple values are allowed e.g. last_name[]=Oyl&last_name[]=Hammon.
emailstringOnly return Customers with an email address matching exactly what is submitted. Multiple values are allowed e.g. email[]=olive.oyl@popeyes.com&email[]=olive.oyl2@gmail.com.
lockedbooleanOnly return locked Customers if true and only return unlocked Customers if false
program_uidstringOnly return Customers belonging to the submitted Program. Multiple values are allowed e.g. program_uid[]=pQtTCSXz57fuefzp&program_uid[]=oPsSBRWy46etdeyo.
business_namestringOnly return Customers with a business name at least partially matching what is submitted. Exact matches will be sorted first.
external_uidstringA unique, immutable id provided by the Client. Multiple values are allowed e.g. external_uid[]=uKxmLxUEiSj5h4M3&external_uid[]=y9reyPMNEWuuYSC1.
pool_uidstringFilter by pool. Multiple values are allowed, e.g. pool_uid[]=wTSMX1GubP21ev2h&pool_uid[]=7UvkHn3Ss9AbWe2c.
limitnumberMaximum number of items to retrieve. This filter is automatically applied with the default value if not given.
offsetnumberIndex of the items to start retrieving from
sortstring

HEADERS

KeyDatatypeRequiredDescription
Acceptstring