Search for customers in the tenant

get

https://eclipse-java-sandbox.ukheshe.rocks/eclipse-conductor/rest/v1/tenants/{tenantId}/customers

Returns customers matching the supplied filters. If fields=customerId is passed, only the customerId of each match is returned without requiring full-profile read permissions.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

tenantId

int64

required

Query Params

accountNumber

string

Account number for any wallet. If it is passed then it will ignore other fields

asylumRefNumber

string

customerId

int64

string

externalUniqueId

string

fields

string

Field data to include. Comma separated list. Supports customerId or positions.

firstName

string

identity

string

includeAdminUsers

boolean

lastName

string

limit

int32

Defaults to 50

nationalIdentityNumber

string

offset

int32

Defaults to 0

onlyShowAllowed

boolean

Defaults to false

When the parameter is set to true, Only the customers that the user has permission to access will be returned. However, if the parameter is set to false and the user does not have permission, will result in an error being thrown.

orderBy

string

Logical field to sort by. Supported values: customerId, lastName, email, phone1, nationalIdentityNumber, created. Unrecognized values fall back to default sorting.

orderDirection

string

Sort direction: ASC or DESC. Defaults to ASC.

organisationId

int64

Search for customers holding a position in this organisation. Only identity, email and externalUniqueId may be combined with this filter. Cannot be combined with walletId, customerId, accountNumber or proxyIdentifier.

passportCountry

string

passportNumber

string

phone1

string

positions

string

Comma-delimited list of one or more Organisation position types (e.g. 'MEMBER,HEAD'). Only valid together with organisationId.

userTypeId

int32

walletId

int64

Responses

200OK

500Internal Server Error