cursorstring
Value indicating your position in the list of all customers. If omitted, the first customers of the list will be returned.
emailstring | null
Primary email address of the customer you're looking for.
external_idstring | null
ID of the customer in a foreign system (Stripe, Aircall etc.) you're looking for.
languagestring | null
The customer's preferred language (format: ISO_639-1) to filter with.
One ofaaabafaksqamaranhyasavaeayazbabmeubebnbhbibsbrbgmycachcezhcucvkwcocrcsdadvnldzen
limitinteger
Maximum number of customers to return.
Default 30
namestring | null
Full name of the customer you're looking for.
order_bystring
Attribute used to order customers.
One ofcreated_datetime:asccreated_datetime:descupdated_datetime:ascupdated_datetime:descDefault "created_datetime:desc"
timezonestring | null
The customer's preferred timezone (format: IANA timezone name).
One ofAfrica/AbidjanAfrica/AccraAfrica/Addis_AbabaAfrica/AlgiersAfrica/AsmaraAfrica/AsmeraAfrica/BamakoAfrica/BanguiAfrica/BanjulAfrica/BissauAfrica/BlantyreAfrica/BrazzavilleAfrica/BujumburaAfrica/CairoAfrica/CasablancaAfrica/CeutaAfrica/ConakryAfrica/DakarAfrica/Dar_es_SalaamAfrica/DjiboutiAfrica/DoualaAfrica/El_AaiunAfrica/FreetownAfrica/GaboroneAfrica/HarareAfrica/JohannesburgAfrica/JubaAfrica/KampalaAfrica/KhartoumAfrica/KigaliAfrica/KinshasaAfrica/LagosAfrica/LibrevilleAfrica/LomeAfrica/LuandaAfrica/LubumbashiAfrica/LusakaAfrica/MalaboAfrica/MaputoAfrica/Maseru
view_idinteger
ID of a view to filter customers by.
channel_typestring
Filter customers by their customer channel types.
channel_addressstring
Filter customers by their customer channel addresses.
