List Customers

get

https://api.cloud.mbanq.com/v1/clients (get)

Maintain a high-level view of your customer base with this powerful discovery and audit tool. Whether you are building administrative dashboards, performing demographic analysis, or syncing customer data with external CRM systems, this API provides a flexible, paginated stream of customer profiles.

This API supports pagination and sorting.

The supported values for Customer Status can be found here: Customer Status.

Example Requests:

/customers
/customers?fields=displayName,officeId
/customers?offset=10&limit=50
/customers?orderBy=firstname&sortOrder=DESC "

Query Params

offset

integer

Indicates the result from which pagination starts. Defaults to 0. Example: 0

limit

integer

Restricts the size of the results returned. Defaults to 200. To override the default and return all entries you must explicitly pass a non-positive integer value for limit e.g. limit=0, or limit=-1 Example: 20

orderBy

string

Defaults to id

The list is sorted by the indicated field. Possible values - id, displayName, accountNo, officeId, officeName. Default: id Example: 'displayName'

sortOrder

string

Specifies the sorting order. Possible values - ASC, DESC Example: 'ASC'

officeId

integer

Provides the ability to restrict the list of customers returned based on the office they are associated with. The default officeId will be 1. Example: 1

displayName

string

Use this field to restrict the results based on display name. Example: Anvita Jay

firstName

string

Use this field to restrict the results based on first name. Example: Anvita

lastName

string

Use this field to restrict the results based on last name. Example: Jay

underHierarchy

string

Provide an office hierarchy value to limit the results to customers within that branch of the hierarchy. Example: 1.1.1.

externalId

string

Use this field to restrict the results based on externa Id. Example: 1100

orphansOnly

boolean

Use orphansOnly as 'true' to list customers that are not associated with any parent. Example: false

clientStatus

string

Use this field to restrict the results based on customer status. Possible values - INVALID, PENDING, ACTIVE, etc. Example: PENDING

mobileNo

string

Use this field to restrict results based on the mobile number. Example: +123456

createdStartDate

string

Use this field to restrict results based on the creation start date.

createdEndDate

string

Use this field to restrict results based on the creation end date.

activatedStartDate

string

Use this field to restrict results based on the activated start date.

activatedEndDate

string

Use this field to restrict results based on the activated end date.

closedStartDate

string

Use this field to restrict results based on the closing start date.

closedEndDate

string

Use this field to restrict results based on the closing end date.

associations

string

Determines which additional data associations should be included in the response. Supported values: additionalDetails, includeOnboardingStatus. Example: associations=includeOnboardingStatus

legalForm

string

enum

Use this field to filter customers by their legal form. Supported values: PERSON, ENTITY

Allowed:

Headers

tenantId

string

required

Defaults to z01j3e71zd6zkq908vyf5861a8

The ID of your banking instance visible in the MBANQ Console.

Response

200The list of customers is retrieved successfully.