Skip to main content
GET
Get list of customers

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is an API key from the API Integration section of your dashboard. Keys are scoped to the company they are generated in — for testing, add a separate test company and generate the key there, so requests never touch your real books.

Query Parameters

num_records
string
default:25

Number of records to fetch(max 100), default : 25 customers will be sent in response

page
integer
default:1

Page number

Response

Customer List fetched successfully

success
boolean

Success flag

Example:

true

message
string

Response message

Example:

""

error_code
string

Error Code

Example:

""

errors
object

Errors

data
object