List member roles

Endpoint

GET /clients/members/roles

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

Your business ID.

Response

boolean

true on success.

string

Human-readable outcome.

array

Array of role objects.

string

Unique role ID. Pass this as memberRoleId when inviting a member.

string

Human-readable role name, e.g. "Admin" or "Viewer".

Code examples

curl -X GET https://sandbox.stellasbank.com/api/v1/clients/members/roles \
  -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/roles",
  {
    headers: {
      "x-api-key": "stl_c8e286ca55b0123e0b05da047494f585",
      "x-api-secret": "stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0",
      businessId: "YOUR_BUSINESS_ID",
    },
  }
);
const { data } = await res.json();

import requests

res = requests.get(
    "https://sandbox.stellasbank.com/api/v1/clients/members/roles",
    headers={
        "x-api-key": "stl_c8e286ca55b0123e0b05da047494f585",
        "x-api-secret": "stl_test_6332e4b1dd6c2e5814395b549aec6deb0d0664406c66f2285f95f801c76117c0",
        "businessId": "YOUR_BUSINESS_ID",
    },
)
print(res.json()["data"])

Example response

{
  "status": true,
  "message": "Roles retrieved successfully",
  "data": [
    { "id": "role_001", "name": "Admin" },
    { "id": "role_002", "name": "Manager" },
    { "id": "role_003", "name": "Viewer" }
  ]
}

Overview

Members

Business

Virtual accounts

Funds

Bulk transfers

Disputes

Subscriptions

Payouts

Audit logs

Settings

Endpoint

Headers

Response

Code examples

Example response

​Endpoint

​Headers

​Response

​Code examples

​Example response

Endpoint

Headers

Response

Code examples

Example response