🔒 List customers V3

get

https://{xentralId}.xentral.biz/api/v3/customers

This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.

This endpoint requires the following scopes: customer:read.

Paginated list of customers.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

filter

array of objects

The filter parameter is used to filter the results of the given endpoint.

Supported filter operators by key:

id: equals, notEquals, in, notIn, isNull, isNotNull

name: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

number: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

email: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

street: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

zipCode: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

city: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

state: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

country: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

salesManager.id: equals, notEquals, in, notIn, isNull, isNotNull

accountManager.id: equals, notEquals, in, notIn, isNull, isNotNull

groups: equals, notEquals, in, notIn

tags: equals, notEquals, in, notIn, contains, notContains, startsWith, endsWith, isNull, isNotNull

tags.id: equals, notEquals, in, notIn, isNull, isNotNull

createdAt: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals, isNull, isNotNull

updatedAt: equals, notEquals, lessThan, lessThanOrEquals, greaterThan, greaterThanOrEquals, isNull, isNotNull

filter

sort

array

Sort via id, -id, name, -name, number, -number, city, -city, zipCode, -zipCode, country, -country, street, -street, state, -state, createdAt, -createdAt, updatedAt and -updatedAt. Default sort is -created_at

sort

include

array of strings

include

perPage

integer

≥ 0

Number of items per page. Default: 15, Max: 100. A larger value is reduced to the maximum; omitting it or sending 0 selects the default.

page

integer

≥ 0

Page number. Only used with simple and table pagination. Omitting it or sending 0 selects the first page.

cursor

string

The cursor to use for the paginated call. Only used with cursor pagination. Not compatible with page parameter

Headers

x-pagination

string

enum

Controls the pagination format. Available types: simple, table, cursor. Defaults to 'simple' if not specified.

Allowed:

Responses

401

Unauthorized

403

Forbidden

200Paginated list of customers.

429Too Many Requests