Skip to main content
POST
/
roles
/
{role_id}
/
permissions
curl -X POST https://api.companyflow.com/roles/550e8400-e29b-41d4-a716-446655440000/permissions \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '[
    {
      "action": "read",
      "resource": "employees"
    },
    {
      "action": "write",
      "resource": "employees",
      "conditions": {"department": "engineering"}
    },
    {
      "action": "read",
      "resource": "departments"
    }
  ]'

{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "company_id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Senior Developer",
    "description": "Senior-level software development position",
    "is_system_role": false,
    "permissions_cache": [
      "employees:read",
      "employees:write",
      "departments:read"
    ],
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T16:20:00Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Falasefemi2/companyflow/llms.txt

Use this file to discover all available pages before exploring further.

Replace all existing permissions for a role with a new set of permissions. This operation will remove any existing permissions and set only the provided ones. Requires Super Admin or HR Manager permissions.
This endpoint replaces ALL existing permissions. Any permissions not included in the request will be removed.

​
Path Parameters

​
role_id
string
required
The unique identifier of the role (UUID format)Example: "550e8400-e29b-41d4-a716-446655440000"

​
Request Body

The request body should be an array of permission objects.
​
action
string
required
The action that can be performed (e.g., “read”, “write”, “delete”)Example: "read"
​
resource
string
required
The resource the permission applies to (e.g., “employees”, “departments”)Example: "employees"
​
conditions
object
Optional conditions that must be met for the permission to applyExample: {"department": "engineering"}

​
Response

​
success
boolean
Indicates if the request was successful
​
data
object
The updated role object with new permissions
curl -X POST https://api.companyflow.com/roles/550e8400-e29b-41d4-a716-446655440000/permissions \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '[
    {
      "action": "read",
      "resource": "employees"
    },
    {
      "action": "write",
      "resource": "employees",
      "conditions": {"department": "engineering"}
    },
    {
      "action": "read",
      "resource": "departments"
    }
  ]'

{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "company_id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Senior Developer",
    "description": "Senior-level software development position",
    "is_system_role": false,
    "permissions_cache": [
      "employees:read",
      "employees:write",
      "departments:read"
    ],
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T16:20:00Z"
  }
}

Build docs developers (and LLMs) love

Get started for freeTalk to us