List Union Members

Retrieves a paginated list of union members with filtering and search capabilities.

Authorization

Requires authentication. Access is role-based:

Admin: Can view all union members
Supervisor: Can view members from unions managed by their credit officers
Credit Officer: Can view members from their assigned unions only

Query Parameters

page

number

default:"1"

Page number for pagination

limit

number

default:"20"

Number of records per page

unionId

string

Filter members by specific union ID

currentOfficerId

string

Filter members by their assigned credit officer ID

string

Search across first name, last name, email, phone, and member code

Response

success

boolean

Indicates if the request was successful

data

array

Array of union member objects

Show Union Member Object

string

Unique member identifier

code

string

Auto-generated member code (e.g., MEM000001)

firstName

string

Member’s first name

lastName

string

Member’s last name

string

Member’s email address

phone

string

Member’s phone number

address

string

Member’s physical address

dateOfBirth

string

Member’s date of birth (ISO 8601 format)

gender

string

Member’s gender

maritalStatus

string

Member’s marital status

profession

string

Member’s profession or occupation

company

string

Member’s employer or company

city

string

City of residence

state

string

State or province

country

string

Country of residence

zipCode

string

Postal or ZIP code

note

string

Additional notes about the member

isVerified

boolean

Whether the member has been verified/approved

unionId

string

ID of the union this member belongs to

union

object

Union details

Show properties

string

Union ID

name

string

Union name

location

string

Union location

currentOfficerId

string

ID of the assigned credit officer

currentOfficer

object

Credit officer details

Show properties

string

Officer ID

firstName

string

Officer first name

lastName

string

Officer last name

string

Officer email

createdAt

string

Timestamp when member was created

updatedAt

string

Timestamp of last update

pagination

object

Pagination metadata

Show properties

total

number

Total number of members matching the query

page

number

Current page number

limit

number

Number of records per page

pages

number

Total number of pages

curl -X GET "https://api.example.com/api/union-members?page=1&limit=20&search=John" \
  -H "Authorization: Bearer YOUR_TOKEN"

{
  "success": true,
  "data": [
    {
      "id": "clx123abc",
      "code": "MEM000001",
      "firstName": "John",
      "lastName": "Doe",
      "email": "[email protected]",
      "phone": "+234-800-000-0000",
      "address": "123 Main Street",
      "dateOfBirth": "1990-01-15T00:00:00.000Z",
      "gender": "Male",
      "maritalStatus": "Married",
      "profession": "Potter",
      "company": "Clay Works Ltd",
      "city": "Lagos",
      "state": "Lagos",
      "country": "Nigeria",
      "zipCode": "100001",
      "note": "Active member since 2020",
      "isVerified": true,
      "unionId": "union_123",
      "union": {
        "id": "union_123",
        "name": "Lagos Potters Union",
        "location": "Ikeja, Lagos"
      },
      "currentOfficerId": "officer_456",
      "currentOfficer": {
        "id": "officer_456",
        "firstName": "Jane",
        "lastName": "Smith",
        "email": "[email protected]"
      },
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-03-10T14:20:00.000Z"
    }
  ],
  "pagination": {
    "total": 150,
    "page": 1,
    "limit": 20,
    "pages": 8
  }
}

Authentication

Unions

Union Members

Loans

Repayments

Reports

Users

System

Authorization

Query Parameters

Response

Build docs developers (and LLMs) love

Authentication

Unions

Union Members

Loans

Repayments

Reports

Users

System

​Authorization

​Query Parameters

​Response

Build docs developers (and LLMs) love

Authorization

Query Parameters

Response