Deals
Get Customers
GET
/
customers
Query Parameters
depth
integer
The number of levels of related objects to include in the response
sort
string
Pass the name of a top-level field to sort by that field in ascending order. Prefix the name of the field with a minus symbol ("-") to sort in descending order.
limit
number
Limit number of results, default 10
where
object
Search for results fitting criteria, uses qs library for query string parsing
Response
200 - application/json
data
object[]
success
boolean
page
number
Current page number
nextPage
number | null
number
of next page, null
if it doesn't exist
prevPage
number | null
number
of previous page, null
if it doesn't exist
totalPages
number
Total pages available, based upon the limit
totalCount
number
Total available records within the database
limit
number
Limit query parameter, defaults to 10
pagingCounter
number
number
of the first record on the current page
hasPrevPage
boolean
true/false
if previous page exists
hasNextPage
boolean
true/false
if next page exists