Zum Inhalt springen
Leadtime
Deutsch
Esc
navigateopen⌘Jpreview

List available permissions

What are Permissions? Permissions are granular access controls that determine what actions users can perform. Each permission represents a specific capability like creating tasks, deleting projects, or managing employees.

What is returned: This endpoint returns all available permissions in the system, organized by functional groups:

  • Tasks: Create, edit, delete, move tasks, manage comments, log time
  • Projects: Create, edit, delete projects, manage project settings
  • Employees: Manage employee data, assign roles, view employee information
  • Organizations: View, create, edit external business partners
  • Roles: Create, edit, delete custom roles
  • Company: Manage company settings and workspace configuration
  • And many more functional areas

Permission structure:

  • Each permission has a unique key (e.g., “projects.create”, “tasks.delete”)
  • Permissions are grouped by functional area for easier management
  • Permission keys use dot notation: “category.action”

Use cases:

  • Build permission management interfaces that show all available permissions
  • Display permission checkboxes grouped by functional area
  • Validate permission keys before assigning them to roles
  • Generate permission documentation or help text
GET/administration/permissions
Authorization
AuthorizationOAuth2 access token · headerrequired
Scopes:api:read
or
AuthorizationBearer token (JWT) · headerrequired
Responses
200
Array of PermissionItem
groupstringrequired
Functional group that this permission belongs to. Permissions are organized into groups like "projects", "tasks", "employees", "roles", etc. for easier management and UI display.
keystringrequired
Unique permission identifier using dot notation format "category.action" (e.g., "projects.create", "tasks.delete"). This key is used when assigning permissions to roles.
401Unauthorized - Invalid or missing authentication token
403Forbidden - Insufficient API scopes or permissions
Request
curl -X GET "https://leadtime.app/api/public/administration/permissions" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Response
[
  {
    "group": "projects",
    "key": "projects.create"
  }
]