HomeDocumentationRecipesAPI ReferenceChangelog
Platform OverviewDemoContactImprintLog In
API Reference
Platform OverviewDemoContactImprint

Query customers

get
https://api.instellix.io/v2/customers/pageable

Returns a paged result with 100 customers by default. Customers are sorted in descending order by ident. This can be changed with the optional direction and orderBy parameters.

Query Params
string

Use RSQL query language. Intro here: https://aboullaite.me/rsql/.

boolean
Defaults to true

If set to false, the response objects will be larger (a lot!) and also contain nested collection fields, i.e. Addresses. This is not recommended!

int32
Defaults to 0

Zero-based page index (0..N). Defines the index of the displayed page.

int32
Defaults to 100

Defines the number of objects per page to be returned.

string
Defaults to ident

Defines the criteria by which the result is ordered.

string
Defaults to DESC

Defines the direction of the ordered response. Default order is descending.

Responses

Updated 2 months ago

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Choose an example:
application/json

Updated 2 months ago