Skip to main content
GET
List customers

Authorizations

X-API-KEY
string
header
required

Query Parameters

search
string | null
id
integer[] | null
company_id
integer[] | null
customer_type
string[] | null
name
string | null
name_exact
string | null
unique_id
string | null
email
string | null
website
string | null
address
string | null
country
string | null
state
string | null
phone
string | null
record_status
enum<string>[] | null
Available options:
draft,
posted,
archived
approval_status
string[] | null
ordering
string | null
default:-updated_at
limit
integer
default:100

Number of records to return per page (capped at 100)

Required range: x >= 1
offset
integer
default:0

Number of records to skip before starting to return results

Required range: x >= 0

Response

OK

items
CustomerListSchemaOut · object[]
required
count
integer
required
Last modified on July 13, 2026