list_customers
Retrieve a list of customers with optional filtering by username.
Instructions
List customers, optionally filtered by username search.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "list_customers"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| start | No | ||
| search | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | True when the upstream HTTP status was < 400. | |
| data | No | Finicity's native response body. | |
| error | No | Error summary when ok is False. | |
| status_code | Yes | Upstream Finicity HTTP status code. |