Retrieve Contact List
Overview
The Retrieve Contact List API allows financial institutions to fetch a paginated list of customer contacts with optional filtering. This query supports customer search and management operations.
Command Details
Command Name: RetrieveContactListQuery
Operation Type: Query (Read Operation)
Use Cases
- Customer Search: Find customers by various criteria
- Customer Directory: Display list of all customers
- Reporting: Generate customer lists for analysis
- Administrative Review: Browse customer database
API Endpoint
POST /api/bpm/qry
Content-Type: application/json
Authorization: Bearer {access_token}
Request Structure
Request Body
{
"queryName": "RetrieveContactListQuery",
"data": {
"pageNumber": 1,
"pageSize": 50,
"searchTerm": "string",
"branchEncodedKey": "string"
}
}
Request Fields
| Field Name | Type | Mandatory | Description |
|---|---|---|---|
pageNumber | Integer | No | Page number (default: 1) |
pageSize | Integer | No | Records per page (default: 50) |
searchTerm | String | No | Search term for filtering |
branchEncodedKey | String | No | Filter by branch |
Sample Requests
1. Get Contact List
{
"queryName": "RetrieveContactListQuery",
"data": {
"pageNumber": 1,
"pageSize": 50
}
}
2. Search Contacts
{
"queryName": "RetrieveContactListQuery",
"data": {
"pageNumber": 1,
"pageSize": 50,
"searchTerm": "john"
}
}
Response Structure
Success Response
{
"isSuccessful": true,
"statusCode": "00",
"message": "Contact list retrieved successfully.",
"data": {
"totalCount": 150,
"pageNumber": 1,
"pageSize": 50,
"contacts": [
{
"contactEncodedKey": "8a8e87e87d1234567890abcd",
"customerNumber": "CUST1000245",
"firstName": "John",
"lastName": "Doe",
"emailAddress": "john.doe@email.com",
"phoneNumber": "+234 123 456 7890",
"isBlacklisted": false
}
]
}
}
Error Handling
| Status Code | Message | Cause |
|---|---|---|
CBS_401 | Unauthorized | Invalid authentication |
CBS_403 | Forbidden | Insufficient permissions |
CBS_500 | Internal server error | System error |
Notes
- Supports pagination for large result sets
- Search term filters across multiple fields
- Returns only customers user has permission to view