Skip to main content
GET
List Customers

Authorizations

Authorization
string
header
required

API token generated from Settings > API Integration. Format: Bearer

Query Parameters

cursor
string

Cursor for the next or previous page, taken from meta.next_cursor or meta.prev_cursor

per_page
integer
default:25

Results per page (max 100)

Required range: x <= 100
filter[query]
string

Search by customer name

filter[lead_status.id][]
integer

Filter by lead status ID

filter[owner.id][]
integer

Filter by owner ID

filter[lead_source.id][]
integer

Filter by lead source ID

filter[priority.id]
integer

Filter by priority ID

filter[date_from]
string<date>

Created after date (YYYY-MM-DD)

filter[date_to]
string<date>

Created before date (YYYY-MM-DD)

Response

Paginated list of customers

success
boolean
Example:

true

data
object[]
meta
object