Skip to main content
GET
/
teams
/
roles
Get Available Roles
curl --request GET \
  --url https://api.rolla.xyz/api/v1/external/teams/roles \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "message": "Roles retrieved successfully",
  "data": {
    "roles": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "Admin",
        "description": "<string>",
        "permissions": [
          "<string>"
        ]
      }
    ]
  }
}
Retrieve the list of roles available for assignment when inviting team members.

​
Example Request

curl -X GET "https://api.rolla.xyz/api/v1/external/teams/roles" \
  -H "X-API-Key: your_api_key_here"

​
Example Response

{
  "status": 200,
  "success": true,
  "message": "Available roles retrieved successfully",
  "data": {
    "roles": [
      {
        "id": "fc4cd36d-f81c-4971-a23f-688162e14d21",
        "name": "business_admin",
        "description": "Full access to business operations, same as business owner"
      },
      {
        "id": "21302ed1-0e63-44e6-bb02-8db6baa2efcd",
        "name": "collaborator",
        "description": "Can create transactions but not approve (limited permissions)"
      }
    ]
  }
}
Use the role id from this response when inviting a team member via the /teams/invite endpoint.

Authorizations

​
X-API-Key
string
header
required

Your Rolla API key

Response

Roles retrieved successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Roles retrieved successfully"

​
data
object