API Reference
GuidesAPI ReferenceRoadmap
API Reference
API Reference

List customers

get
https://{xentralId}.xentral.biz/api/v2/customers

Fetches a list of customers based on provided filters and pagination parameters. This endpoint supports filtering by various customer attributes, as well as cursor and page-based pagination for efficient data retrieval.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
filter
page
object

Page-based pagination (Default). Use this or cursor, but not both. If both are provided, an exception will be thrown.

cursor
object

Cursor-based pagination. Use this or page, but not both. If both are provided, an exception will be thrown.

order
array of objects
order
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

403

Unable to authorize the client

404

Resource was not found or not enough access privileges

406

Requested resource representation does not exist.

Updated 5 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json
text/html

Updated 5 months ago