Skip to main content
GET
/
roles
/
{id}
curl -X GET https://api.companyflow.com/roles/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer YOUR_TOKEN"

{
  "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"],
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30: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.

Get detailed information about a specific role. Requires Super Admin or HR Manager permissions.

​
Path Parameters

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

​
Response

​
success
boolean
Indicates if the request was successful
​
data
object
The role object
curl -X GET https://api.companyflow.com/roles/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer YOUR_TOKEN"

{
  "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"],
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}

Build docs developers (and LLMs) love

Get started for freeTalk to us