Search for customers in the tenant

get

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

This is a general API for searching for customers based on various criteria. If fields=customerId is passed as a query parameter, then only the customerId of each matching customer would be returned and one does not need permissions to read the customers full profile. It then behaves the same as the HEAD method but returns the customerId of each customer as opposed to no body at all.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

tenantId

int64

required

Query Params

accountNumber

string

Represent Accountnumber 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.

passportCountry

string

passportNumber

string

phone1

string

userTypeId

int32

walletId

int64

Response

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK