GET

https://{environment}.straddle.io

/
v1
/
customers

Authorizations

Authorization
string
headerrequired

Use your Straddle API Key in the Authorization header as Bearer <token> to authorize API requests.

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

Page number for paginated results. Starts at 1. Default: 1.

page_size
integer

Number of results per page. Default: 100. Maximum: 1000.

sort_by
enum<string>
Available options:
name,
created_at
sort_order
enum<string>
Available options:
asc,
desc
created_from
string

Start date for filtering by creation date.

created_to
string

End date for filtering by creation date.

name
string

Filter customers by name (partial match).

external_id
string

Filter by your system's customer identifier.

email
string

Filter customers by email address.

status
enum<string>[]

Filter customers by their current status.

Available options:
pending,
review,
verified,
inactive,
rejected
search_text
string

General search term to filter customers.

types
enum<string>[]

Filter by customer type ('individual' or 'business').

Available options:
individual,
business

Response

200 - text/plain
meta
object
required
response_type
enum<string>
required
Available options:
object,
array,
error,
none
data
object[]
required
Delete a customerInitiate a widget session