Command Palette

Search for a command to run...

B
Bankayo Nexus
Getting StartedAPI ReferenceGuidesRequest Feature
GitHubRequestTry API

API Explorer

Test endpoints interactively

GEThttps://demo.fineract.dev/fineract-provider/api/v1/clients

List all clients

Retrieves a list of all clients in the system. Supports pagination and filtering by various attributes including office, status, and display name.

Connection Settings

Parameters

officeIdintegerquery

Filter by office ID

displayNamestringquery

Filter by display name (partial match)

statusstringquery

Filter by client status (active, pending, closed)

externalIdstringquery

Filter by external reference ID

orphansOnlybooleanquery

Return only orphaned clients

sqlSearchstringquery

SQL-style search query

offsetintegerquery

Pagination offset

limitintegerquery

Maximum number of results

orderBystringquery

Field to order results by

sortOrderstringquery

Sort direction (ASC or DESC)