Skip to main content

​
Endpoint

GET /clients/members

​
Headers

​
Authorization
string
required
Bearer YOUR_ACCESS_TOKEN
​
SECRET_KEY
string
required
Your API secret key.
​
businessId
string
required
The ID of the business whose members you want to list.

​
Query parameters

​
page
integer
Page number. Defaults to 1.
​
limit
integer
Records per page. Defaults to 10.
See Pagination for full usage.

​
Response

​
status
boolean
true on success.
​
message
string
Human-readable outcome.
​
data
array
Array of member objects.
​
data[].id
string
Unique member ID.
​
data[].firstName
string
Member’s first name.
​
data[].lastName
string
Member’s last name.
​
data[].email
string
Member’s email address.
​
data[].phoneNo
string
Member’s phone number.
​
data[].isActive
boolean
true if the member’s account is active.
​
data[].clientMemberRoleId
string
ID of the role assigned to this member.
​
data[].clientMemberRole
object
The role object containing id and name.
​
data[].clientId
string
The client account ID this member belongs to.
​
pagination
object
Standard pagination envelope. See Pagination.

​
Code examples

curl -X GET "https://sandbox.stellasbank.com/api/v1/clients/members?page=1&limit=10" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "SECRET_KEY: YOUR_SECRET_KEY" \
  -H "businessId: YOUR_BUSINESS_ID"

​
Example response

{
  "status": true,
  "message": "Members retrieved successfully",
  "data": [
    {
      "id": "mem_abc123",
      "firstName": "Ada",
      "lastName": "Lovelace",
      "email": "ada@example.com",
      "phoneNo": "+2348012345678",
      "isActive": true,
      "clientMemberRoleId": "role_xyz",
      "clientMemberRole": { "id": "role_xyz", "name": "Admin" },
      "clientId": "client_001"
    }
  ],
  "pagination": {
    "totalCount": 12,
    "hasNextPage": true,
    "hasPreviousPage": false,
    "nextPage": 2,
    "previousPage": 0,
    "limit": 10,
    "lastPage": 2
  }
}