Karma Common API
​number · min: 1​number · min: 1 · max: 1000​string
​string · minLength: 1 · maxLength: 100 · required​number[] · required​string | null​string
​number · required​string · minLength: 1 · maxLength: 100​string​number[]​string
Role management with permission assignment
List roles
GET
https://common-api.karma.life
/api/v1/roles
List all roles in a company with optional filters
Note: KARMELEON role is automatically filtered from results
Permissions: 🔵 roles.read
query Parameters
pageDefault: 1
limitDefault: 50
List roles › Responses
Default Response
status​object
​object
Create role
POST
https://common-api.karma.life
/api/v1/roles
Create a new role in the company
Permissions: 🟢 roles.create
Create role › Request Body
namepermissionIdsArray of permission IDs to assign to this role
descriptionOptional role description
Create role › Responses
Default Response
status​object
​object
Update role
PUT
https://common-api.karma.life
/api/v1/roles/{id}
Update an existing role
Note: Cannot update system roles or KARMELEON role
Permissions: 🟠roles.update
path Parameters
idRole ID
Update role › Request Body
namedescriptionOptional role description
permissionIdsArray of permission IDs to assign to this role
Update role › Responses
Default Response
status​object
​object