Customers
Search customers
Search customers with filters
GET
/
v1
/
customers
Authorizations
Authorization
string
headerrequiredJWT Authorization header using the Bearer scheme. Enter 'Bearer ' [space] and then your token in the text input below.
Headers
Straddle-Account-Id
string
For use by platforms to specify an account id and set scope of a request.
Request-Id
string
Optional client generated identifier to trace and debug a request.
Correlation-Id
string
Optional client generated identifier to trace and debug a series of requests.
Query Parameters
page_number
integer
Results page number. Starts at page 1. Default value: 1
page_size
integer
Page size. Default value: 100. Max value: 1000
sort_by
enum<string>
Available options:
name
, created_at
sort_order
enum<string>
Available options:
asc
, desc
created_from
string
Created from
created_to
string
Created to
name
string
Optional name filter.
external_id
string
Optional external_id filter.
email
string
Optional email filter.
status
enum<string>[]
Optional status filter.
Available options:
pending
, review
, verified
, inactive
, rejected
search_text
string
Optional Search filter.
types
enum<string>[]
Optional customer type filter.
Available options:
individual
, business
Response
200 - text/plain
meta
object
response_type
string | null
The type of the response
data
object[] | null
The data of the response