List and Retrieve Group Members via the Save App API

The List Members endpoints return MemberEntity objects for every non-deleted user in the authenticated user’s group. Results are ordered by role then name, and credit scores are resolved server-side — your client receives a pre-calculated reliability_label, reliability_color, and is_eligible flag with every record. An admin JWT is required to list all members; regular members may only retrieve their own profile via the single-member endpoint.

List all members

integer

default:20

Maximum number of members to return. Must be between 1 and 100.

integer

default:0

Zero-based index of the first record to return. Use with limit for pagination.

Response

The response is wrapped in a PaginatedResponse envelope.

MemberEntity[]

Array of member objects for the current page.

integer

Total number of members in the group (across all pages).

integer

The limit value that was applied to this request.

integer

The offset value that was applied to this request.

MemberEntity fields

string

UUID that uniquely identifies the member.

string

Full display name of the member.

string

Phone number in Uganda format, e.g. +256700123456.

string

Either "admin" or "member".

string

Name of the savings group this member belongs to.

float

Total contributions the member has made to the group, in UGX.

float

Outstanding contribution shortfall, in UGX. 0.0 if the member is up to date.

boolean

true if the member has already received a payout in the current cycle.

boolean

true if the member account is active. false if suspended.

boolean

true if this member is the original creator of the group.

string

Account status: "active" or "pending". New members created by an admin start as "pending" until they complete onboarding.

datetime

ISO 8601 timestamp of when the member record was created.

string

Human-readable reliability classification calculated from the credit score, e.g. "ELIGIBLE".

string

Hex color code corresponding to the reliability label, e.g. "#10B981". Use this to colour-code member cards in your UI.

boolean

true if the member currently qualifies for a loan based on their credit score and group standing.

integer

Numeric credit score. The scale runs from 300 (minimum) to 850 (maximum), with new members starting at 500.

Example

curl --request GET \
  --url "https://api.saveapp.io/api/members?limit=20&offset=0" \
  --header "Authorization: Bearer <admin_token>"

curl --request GET \
  --url "https://api.saveapp.io/api/members/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  --header "Authorization: Bearer <token>"

Sample response (list)

{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Aisha Nakato",
      "phone": "+256700123456",
      "role": "admin",
      "group_name": "Kampala Savers",
      "contribution_paid": 450000.0,
      "shortfall_amount": 0.0,
      "has_received_payout": false,
      "is_active": true,
      "is_creator": true,
      "status": "active",
      "created_at": "2024-01-15T08:30:00Z",
      "reliability_label": "ELIGIBLE",
      "reliability_color": "#10B981",
      "is_eligible": true,
      "credit_score": 720
    }
  ],
  "total": 1,
  "limit": 20,
  "offset": 0
}

Auth

Members

Loans

Transactions & Payouts

Analytics & Config

List and Retrieve Group Members via the Save App API

List all members

Response

MemberEntity fields

Example

​List all members

​Response

​MemberEntity fields

​Example

List all members

Response

MemberEntity fields

Example