Skip to main content
GET
List Customers

Authorizations

Authorization
string
header
required

OAuth2 access token obtained from POST /api/oauth/token/ using client credentials.

Query Parameters

customer_type
enum<string>

Filter by customer type (INDIVIDUAL or COMPANY)

Available options:
COMPANY,
INDIVIDUAL
external_id
string

Filter by external ID

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Search customers by name

Response

200 - application/json
count
integer
required
Example:

123

results
object[]
required
next
string<uri> | null
Example:

"http://api.example.org/accounts/?page=4"

previous
string<uri> | null
Example:

"http://api.example.org/accounts/?page=2"