List members

Endpoint

GET /clients/members

Headers

string

required

Your public API key.

string

required

Your API secret. Use a stl_test_... value in sandbox, stl_live_... in production.

string

required

The ID of the business whose members you want to list.

Query parameters

integer

Page number. Defaults to 1.

integer

Records per page. Defaults to 10.

See Pagination for full usage.

Response

boolean

true on success.

string

Human-readable outcome.

array

Array of member objects.

string

Unique member ID.

string

Member’s first name.

string

Member’s last name.

string

Member’s email address.

string

Member’s phone number.

boolean

true if the member’s account is active.

string

ID of the role assigned to this member.

object

The role object containing id and name.

string

The client account ID this member belongs to.

object

Standard pagination envelope. See Pagination.

Code examples

curl -X GET "https://sandbox.stellasbank.com/api/v1/clients/members?page=1&limit=10" \
  -H "x-api-key: stl_c8e286ca55b0123e0b05da047494f585" \
  -H "x-api-secret: stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0" \
  -H "businessId: YOUR_BUSINESS_ID"

const res = await fetch(
  "https://sandbox.stellasbank.com/api/v1/clients/members?page=1&limit=10",
  {
    headers: {
      "x-api-key": "stl_c8e286ca55b0123e0b05da047494f585",
      "x-api-secret": "stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0",
      businessId: "YOUR_BUSINESS_ID",
    },
  }
);
const { data, pagination } = await res.json();

import requests

res = requests.get(
    "https://sandbox.stellasbank.com/api/v1/clients/members",
    headers={
        "x-api-key": "stl_c8e286ca55b0123e0b05da047494f585",
        "x-api-secret": "stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0",
        "businessId": "YOUR_BUSINESS_ID",
    },
    params={"page": 1, "limit": 10},
)
print(res.json())

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
  }
}

Overview

Members

Business

Virtual accounts

Funds

Bulk transfers

Disputes

Subscriptions

Payouts

Audit logs

Settings

Endpoint

Headers

Query parameters

Response

Code examples

Example response

​Endpoint

​Headers

​Query parameters

​Response

​Code examples

​Example response

Endpoint

Headers

Query parameters

Response

Code examples

Example response