Skip to main content

​
Endpoint

GET /clients/members/roles

​
Headers

​
Authorization
string
required
Bearer YOUR_ACCESS_TOKEN
​
SECRET_KEY
string
required
Your API secret key.
​
businessId
string
required
Your business ID.

​
Response

​
status
boolean
true on success.
​
message
string
Human-readable outcome.
​
data
array
Array of role objects.
​
data[].id
string
Unique role ID. Pass this as memberRoleId when inviting a member.
​
data[].name
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 "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "SECRET_KEY: YOUR_SECRET_KEY" \
  -H "businessId: YOUR_BUSINESS_ID"

​
Example response

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