1. Tenant Scoped
AI Command Room
  • Authenticated
    • Projects
      • Get Projects for Tenant
      • Create Project
      • Update Project
      • Delete Project
      • Get Projects for Tenant
      • Create Project
      • Update Project
      • Delete Project
    • Tags
      • Get All Tags
      • Create Tag
      • Update Tag
      • Delete Tag
      • Get All Tags
      • Create Tag
      • Update Tag
      • Delete Tag
    • Tasks
      • Get All Tasks
      • Get Tasks Under DDDEEE column
      • Get My Automations Stats
      • Get All Tasks
      • Get Tasks Under DDDEEE column
      • Get My Automations Stats
    • Idea Capture
      • Transcribe Audio
      • Generate PRD
      • Generate Implementation Steps
      • Generate Build Steps
      • Create Task
      • Generate PRD PDF
      • Create Build Step
      • Create Implementation Step
      • Create Task
      • Generate PRD PDF
      • Create Build Step
      • Create Implementation Step
    • Organizations
      • Create Org Chart
      • Create Org Chart
    • Metrics
      • Get Business Value Impact Time Series
      • Get Business Value Impact Time Series
    • Automations
      • Get Automation Stats
      • Get Value Impact (Executions)
      • Get Automation Stats
      • Get Value Impact (Executions)
    • Client Collaboration
      • GET Access Requests (index)
      • POST Access Requests (store)
      • GET Incoming (incoming)
      • GET Own (own)
      • GET Item (show)
      • PUT Item (update)
      • PATCH Item (update)
      • DELETE Item (destroy)
      • POST Approve (approve)
      • POST Decline (decline)
      • POST Revoke (revoke)
      • GET Access Requests (index)
      • POST Access Requests (store)
      • GET Incoming (incoming)
      • GET Own (own)
      • GET Item (show)
      • PUT Item (update)
      • PATCH Item (update)
      • DELETE Item (destroy)
      • POST Approve (approve)
      • POST Decline (decline)
      • POST Revoke (revoke)
    • Non-Tenant
      • GET Auth (authenticate)
      • POST Auth (authenticate)
      • POST Logout (logout)
      • GET Notifications (index)
      • GET By Type (getByType)
      • POST Clear Read (clearRead)
      • POST Mark All Read (markAllAsRead)
      • GET Unread Count (unreadCount)
      • DELETE Item (destroy)
      • POST Mark Read (markAsRead)
      • GET Item (show)
      • PATCH Business Valuation Multiplier (updateBusinessValuationMultiplier)
      • GET Search (search)
      • GET Item (getByJobId)
      • PATCH Status (updateStatus)
      • POST Results (storeResult)
      • GET Public Automations (getPublicAutomations)
      • Get Multiplai User
      • GET Auth (authenticate)
      • POST Auth (authenticate)
      • POST Logout (logout)
      • GET Notifications (index)
      • GET By Type (getByType)
      • POST Clear Read (clearRead)
      • POST Mark All Read (markAllAsRead)
      • GET Unread Count (unreadCount)
      • DELETE Item (destroy)
      • POST Mark Read (markAsRead)
      • GET Item (show)
      • PATCH Business Valuation Multiplier (updateBusinessValuationMultiplier)
      • GET Search (search)
      • GET Item (getByJobId)
      • PATCH Status (updateStatus)
      • POST Results (storeResult)
      • GET Public Automations (getPublicAutomations)
      • Get Multiplai User
    • Tenant Scoped
      • GET Comments (index)
        GET
      • POST Comments (store)
        POST
      • GET Item (show)
        GET
      • PUT Item (update)
        PUT
      • PATCH Item (update)
        PATCH
      • DELETE Item (destroy)
        DELETE
      • POST Reactions (addReaction)
        POST
      • POST Replies (storeReply)
        POST
      • Multiplai Dev - Departments
        GET
      • POST Resolve User Ids (resolveUserIds)
        POST
      • GET Users (teamUsers)
        GET
      • GET Tree (tree)
        GET
      • GET Paginated (treePaginated)
        GET
      • GET Item (show)
        GET
      • GET Teams (departmentTeams)
        GET
      • GET Files (index)
        GET
      • POST Files (store)
        POST
      • GET Item (show)
        GET
      • PUT Item (update)
        PUT
      • PATCH Item (update)
        PATCH
      • DELETE Item (destroy)
        DELETE
      • GET Workflow Executions (getWorkflowExecutionsForMetrics)
        GET
      • POST Time Series (getWorkflowExecutionsTimeSeries)
        POST
      • POST Time Series (getWorkflowsTimeSeries)
        POST
      • GET Orgcharts (index)
        GET
      • GET Active (getActive)
        GET
      • GET Item (showShallow)
        GET
      • PUT Item (updateShallow)
        PUT
      • DELETE Item (destroyShallow)
        DELETE
      • POST Parse File (parseUploadedFile)
        POST
      • GET Download (downloadTemplate)
        GET
      • POST Validate Csv (validateCsv)
        POST
      • PUT Positions (updatePositions)
        PUT
      • GET Item (show)
        GET
      • PUT Item (update)
        PUT
      • PATCH Item (update)
        PATCH
      • DELETE Item (destroy)
        DELETE
      • POST Archive (archive)
        POST
      • POST Deactivate (deactivate)
        POST
      • GET Nodes (index)
        GET
      • POST Nodes (store)
        POST
      • GET Item (show)
        GET
      • PUT Item (update)
        PUT
      • PATCH Item (update)
        PATCH
      • DELETE Item (destroy)
        DELETE
      • GET Ai Automations (index)
        GET
      • POST Ai Automations (store)
        POST
      • POST From Suggestion (createFromSuggestion)
        POST
      • GET Grouped (grouped)
        GET
      • GET Savings (savings)
        GET
      • GET Item (show)
        GET
      • PUT Item (update)
        PUT
      • PATCH Item (update)
        PATCH
      • DELETE Item (destroy)
        DELETE
      • POST Implemented (markImplemented)
        POST
      • POST Link Rea Agent (linkExistingReaAgent)
        POST
      • POST Sync To Rea (syncToRea)
        POST
      • GET Added (getAdded)
        GET
      • GET Suggestions (getSuggestions)
        GET
      • POST Sync (syncAgent)
        POST
      • GET Synced (getSynced)
        GET
      • DELETE Item (unsyncAgent)
        DELETE
      • PUT Forecast (updateForecast)
        PUT
      • POST Set Active (setActive)
        POST
      • POST Unarchive (unarchive)
        POST
      • PUT Sort (updateSort)
        PUT
      • GET Item (show)
        GET
      • Update Project
        PUT
      • PATCH Item (update)
        PATCH
      • Delete Project
        DELETE
      • GET Task Groups (index)
        GET
      • PUT Reorder (reorder)
        PUT
      • Get Tasks Under DDDEEE column
        GET
      • GET Research Reports (index)
        GET
      • POST Research Reports (store)
        POST
      • GET My Prospects (myProspects)
        GET
      • GET My Reports (myReports)
        GET
      • GET Pending (pending)
        GET
      • POST Register (register)
        POST
      • GET Stats (stats)
        GET
      • POST Generate Org Chart (generateOrgChart)
        POST
      • GET Item (show)
        GET
      • DELETE Item (destroy)
        DELETE
      • GET Roles (index)
        GET
      • POST Roles (store)
        POST
      • GET Permissions (permissions)
        GET
      • GET Templates (templates)
        GET
      • GET Item (show)
        GET
      • PUT Item (update)
        PUT
      • PATCH Item (update)
        PATCH
      • DELETE Item (destroy)
        DELETE
      • POST Apply Template (applyTemplate)
        POST
      • POST Assign Users (assignUsers)
        POST
      • POST Clone (clone)
        POST
      • POST Remove Users (removeUsers)
        POST
      • GET Users (roleUsers)
        GET
      • GET Software (index)
        GET
      • POST Software (store)
        POST
      • GET Item (show)
        GET
      • PUT Item (update)
        PUT
      • PATCH Item (update)
        PATCH
      • DELETE Item (destroy)
        DELETE
      • POST Reorder (reorder)
        POST
      • GET Item (show)
        GET
      • PUT Item (update)
        PUT
      • PATCH Item (update)
        PATCH
      • DELETE Item (destroy)
        DELETE
      • GET Task Groups (index)
        GET
      • POST Task Groups (store)
        POST
      • GET Item (show)
        GET
      • PUT Item (update)
        PUT
      • PATCH Item (update)
        PATCH
      • DELETE Item (destroy)
        DELETE
      • POST Tasks (addTasks)
        POST
      • DELETE Tasks (removeTasks)
        DELETE
      • GET Tasks (index)
        GET
      • GET Task Shares (index)
        GET
      • POST Task Shares (store)
        POST
      • POST Increment Usage (incrementUsage)
        POST
      • POST Share Publicly (sharePublicly)
        POST
      • POST Share With Organization (shareWithOrganization)
        POST
      • GET Shared Automations (getSharedAutomations)
        GET
      • POST Unshare (unshare)
        POST
      • GET Item (show)
        GET
      • PUT Item (update)
        PUT
      • PATCH Item (update)
        PATCH
      • DELETE Item (destroy)
        DELETE
      • GET Stats (stats)
        GET
      • POST Automation Target Metrics (getAutomationTargetMetrics)
        POST
      • DELETE Bulk Delete (bulkDelete)
        DELETE
      • GET Item (showBySlug)
        GET
      • POST Copy Shared Automation (copySharedAutomation)
        POST
      • POST Mass Update (massUpdate)
        POST
      • GET My Automations (getMyAutomations)
        GET
      • GET My Automations Value Impact (getMyAutomationsValueImpact)
        GET
      • GET My Executions (getMyWorkflowExecutions)
        GET
      • GET Grouped (getMyWorkflowExecutionsGrouped)
        GET
      • GET Workflow Execution Count (getWorkflowExecutionCount)
        GET
      • GET Item (show)
        GET
      • PUT Item (update)
        PUT
      • PATCH Item (update)
        PATCH
      • DELETE Item (destroy)
        DELETE
      • PUT Assignees (updateAssignees)
        PUT
      • PUT Build Steps (bulkUpdate)
        PUT
      • GET Build Steps (index)
        GET
      • Create Build Step
        POST
      • GET Item (show)
        GET
      • PUT Item (update)
        PUT
      • PATCH Item (update)
        PATCH
      • DELETE Item (destroy)
        DELETE
      • GET Comments (index)
        GET
      • GET Files (index)
        GET
      • POST Rea (attachReaWorkflow)
        POST
      • PATCH Rea (refreshReaWorkflowStatus)
        PATCH
      • DELETE Rea (detachReaWorkflow)
        DELETE
      • PUT Remove Assignees (removeAllAssignees)
        PUT
      • GET Steps (index)
        GET
      • POST Steps (store)
        POST
      • GET Item (show)
        GET
      • PUT Item (update)
        PUT
      • PATCH Item (update)
        PATCH
      • DELETE Item (destroy)
        DELETE
      • PUT Tags (updateTags)
        PUT
      • PUT Team (updateTeam)
        PUT
      • POST Trigger_updated (triggerTaskUpdated)
        POST
      • POST Uploads (attachUpload)
        POST
      • DELETE Item (detachUpload)
        DELETE
      • Multiplai Dev - Teams
        GET
      • POST Teams (store)
        POST
      • GET Item (show)
        GET
      • PUT Item (update)
        PUT
      • DELETE Item (destroy)
        DELETE
      • PATCH Move Down (moveDown)
        PATCH
      • PATCH Move Up (moveUp)
        PATCH
      • DELETE Remove Team Lead (removeTeamLead)
        DELETE
      • POST Set Team Lead (setTeamLead)
        POST
      • POST Uploads (store)
        POST
      • POST Signed Url (getSignedUrl)
        POST
      • PUT Item (update)
        PUT
      • DELETE Item (destroy)
        DELETE
      • GET Download Url (getDownloadUrl)
        GET
      • GET Preview (preview)
        GET
      • GET Users (organizationUsers)
        GET
      • POST Invite (inviteMember)
        POST
      • GET Item (show)
        GET
      • PUT Item (update)
        PUT
      • POST Activate (activate)
        POST
      • POST Avatar (updateAvatar)
        POST
      • DELETE Avatar (removeAvatar)
        DELETE
      • DELETE Remove (removeFromOrganization)
        DELETE
      • POST Suspend (suspend)
        POST
      • GET Comments (index)
        GET
      • POST Comments (store)
        POST
      • GET Item (show)
        GET
      • PUT Item (update)
        PUT
      • PATCH Item (update)
        PATCH
      • DELETE Item (destroy)
        DELETE
      • POST Reactions (addReaction)
        POST
      • POST Replies (storeReply)
        POST
      • Multiplai Dev - Departments
        GET
      • POST Resolve User Ids (resolveUserIds)
        POST
      • GET Users (teamUsers)
        GET
      • GET Tree (tree)
        GET
      • GET Paginated (treePaginated)
        GET
      • GET Item (show)
        GET
      • GET Teams (departmentTeams)
        GET
      • GET Files (index)
        GET
      • POST Files (store)
        POST
      • GET Item (show)
        GET
      • PUT Item (update)
        PUT
      • PATCH Item (update)
        PATCH
      • DELETE Item (destroy)
        DELETE
      • GET Workflow Executions (getWorkflowExecutionsForMetrics)
        GET
      • POST Time Series (getWorkflowExecutionsTimeSeries)
        POST
      • POST Time Series (getWorkflowsTimeSeries)
        POST
      • GET Orgcharts (index)
        GET
      • GET Active (getActive)
        GET
      • GET Item (showShallow)
        GET
      • PUT Item (updateShallow)
        PUT
      • DELETE Item (destroyShallow)
        DELETE
      • POST Parse File (parseUploadedFile)
        POST
      • GET Download (downloadTemplate)
        GET
      • POST Validate Csv (validateCsv)
        POST
      • PUT Positions (updatePositions)
        PUT
      • GET Item (show)
        GET
      • PUT Item (update)
        PUT
      • PATCH Item (update)
        PATCH
      • DELETE Item (destroy)
        DELETE
      • POST Archive (archive)
        POST
      • POST Deactivate (deactivate)
        POST
      • GET Nodes (index)
        GET
      • POST Nodes (store)
        POST
      • GET Item (show)
        GET
      • PUT Item (update)
        PUT
      • PATCH Item (update)
        PATCH
      • DELETE Item (destroy)
        DELETE
      • GET Ai Automations (index)
        GET
      • POST Ai Automations (store)
        POST
      • POST From Suggestion (createFromSuggestion)
        POST
      • GET Grouped (grouped)
        GET
      • GET Savings (savings)
        GET
      • GET Item (show)
        GET
      • PUT Item (update)
        PUT
      • PATCH Item (update)
        PATCH
      • DELETE Item (destroy)
        DELETE
      • POST Implemented (markImplemented)
        POST
      • POST Link Rea Agent (linkExistingReaAgent)
        POST
      • POST Sync To Rea (syncToRea)
        POST
      • GET Added (getAdded)
        GET
      • GET Suggestions (getSuggestions)
        GET
      • POST Sync (syncAgent)
        POST
      • GET Synced (getSynced)
        GET
      • DELETE Item (unsyncAgent)
        DELETE
      • PUT Forecast (updateForecast)
        PUT
      • POST Set Active (setActive)
        POST
      • POST Unarchive (unarchive)
        POST
      • PUT Sort (updateSort)
        PUT
      • GET Item (show)
        GET
      • Update Project
        PUT
      • PATCH Item (update)
        PATCH
      • Delete Project
        DELETE
      • GET Task Groups (index)
        GET
      • PUT Reorder (reorder)
        PUT
      • Get Tasks Under DDDEEE column
        GET
      • GET Research Reports (index)
        GET
      • POST Research Reports (store)
        POST
      • GET My Prospects (myProspects)
        GET
      • GET My Reports (myReports)
        GET
      • GET Pending (pending)
        GET
      • POST Register (register)
        POST
      • GET Stats (stats)
        GET
      • POST Generate Org Chart (generateOrgChart)
        POST
      • GET Item (show)
        GET
      • DELETE Item (destroy)
        DELETE
      • GET Roles (index)
        GET
      • POST Roles (store)
        POST
      • GET Permissions (permissions)
        GET
      • GET Templates (templates)
        GET
      • GET Item (show)
        GET
      • PUT Item (update)
        PUT
      • PATCH Item (update)
        PATCH
      • DELETE Item (destroy)
        DELETE
      • POST Apply Template (applyTemplate)
        POST
      • POST Assign Users (assignUsers)
        POST
      • POST Clone (clone)
        POST
      • POST Remove Users (removeUsers)
        POST
      • GET Users (roleUsers)
        GET
      • GET Software (index)
        GET
      • POST Software (store)
        POST
      • GET Item (show)
        GET
      • PUT Item (update)
        PUT
      • PATCH Item (update)
        PATCH
      • DELETE Item (destroy)
        DELETE
      • POST Reorder (reorder)
        POST
      • GET Item (show)
        GET
      • PUT Item (update)
        PUT
      • PATCH Item (update)
        PATCH
      • DELETE Item (destroy)
        DELETE
      • GET Task Groups (index)
        GET
      • POST Task Groups (store)
        POST
      • GET Item (show)
        GET
      • PUT Item (update)
        PUT
      • PATCH Item (update)
        PATCH
      • DELETE Item (destroy)
        DELETE
      • POST Tasks (addTasks)
        POST
      • DELETE Tasks (removeTasks)
        DELETE
      • GET Tasks (index)
        GET
      • GET Task Shares (index)
        GET
      • POST Task Shares (store)
        POST
      • POST Increment Usage (incrementUsage)
        POST
      • POST Share Publicly (sharePublicly)
        POST
      • POST Share With Organization (shareWithOrganization)
        POST
      • GET Shared Automations (getSharedAutomations)
        GET
      • POST Unshare (unshare)
        POST
      • GET Item (show)
        GET
      • PUT Item (update)
        PUT
      • PATCH Item (update)
        PATCH
      • DELETE Item (destroy)
        DELETE
      • GET Stats (stats)
        GET
      • POST Automation Target Metrics (getAutomationTargetMetrics)
        POST
      • DELETE Bulk Delete (bulkDelete)
        DELETE
      • GET Item (showBySlug)
        GET
      • POST Copy Shared Automation (copySharedAutomation)
        POST
      • POST Mass Update (massUpdate)
        POST
      • GET My Automations (getMyAutomations)
        GET
      • GET My Automations Value Impact (getMyAutomationsValueImpact)
        GET
      • GET My Executions (getMyWorkflowExecutions)
        GET
      • GET Grouped (getMyWorkflowExecutionsGrouped)
        GET
      • GET Workflow Execution Count (getWorkflowExecutionCount)
        GET
      • GET Item (show)
        GET
      • PUT Item (update)
        PUT
      • PATCH Item (update)
        PATCH
      • DELETE Item (destroy)
        DELETE
      • PUT Assignees (updateAssignees)
        PUT
      • PUT Build Steps (bulkUpdate)
        PUT
      • GET Build Steps (index)
        GET
      • Create Build Step
        POST
      • GET Item (show)
        GET
      • PUT Item (update)
        PUT
      • PATCH Item (update)
        PATCH
      • DELETE Item (destroy)
        DELETE
      • GET Comments (index)
        GET
      • GET Files (index)
        GET
      • POST Rea (attachReaWorkflow)
        POST
      • PATCH Rea (refreshReaWorkflowStatus)
        PATCH
      • DELETE Rea (detachReaWorkflow)
        DELETE
      • PUT Remove Assignees (removeAllAssignees)
        PUT
      • GET Steps (index)
        GET
      • POST Steps (store)
        POST
      • GET Item (show)
        GET
      • PUT Item (update)
        PUT
      • PATCH Item (update)
        PATCH
      • DELETE Item (destroy)
        DELETE
      • PUT Tags (updateTags)
        PUT
      • PUT Team (updateTeam)
        PUT
      • POST Trigger_updated (triggerTaskUpdated)
        POST
      • POST Uploads (attachUpload)
        POST
      • DELETE Item (detachUpload)
        DELETE
      • Multiplai Dev - Teams
        GET
      • POST Teams (store)
        POST
      • GET Item (show)
        GET
      • PUT Item (update)
        PUT
      • DELETE Item (destroy)
        DELETE
      • PATCH Move Down (moveDown)
        PATCH
      • PATCH Move Up (moveUp)
        PATCH
      • DELETE Remove Team Lead (removeTeamLead)
        DELETE
      • POST Set Team Lead (setTeamLead)
        POST
      • POST Uploads (store)
        POST
      • POST Signed Url (getSignedUrl)
        POST
      • PUT Item (update)
        PUT
      • DELETE Item (destroy)
        DELETE
      • GET Download Url (getDownloadUrl)
        GET
      • GET Preview (preview)
        GET
      • GET Users (organizationUsers)
        GET
      • POST Invite (inviteMember)
        POST
      • GET Item (show)
        GET
      • PUT Item (update)
        PUT
      • POST Activate (activate)
        POST
      • POST Avatar (updateAvatar)
        POST
      • DELETE Avatar (removeAvatar)
        DELETE
      • DELETE Remove (removeFromOrganization)
        DELETE
      • POST Suspend (suspend)
        POST
    • Global Admin
      • GET Organizations (organizations)
      • GET Statistics (statistics)
      • GET Users (index)
      • POST Bulk Assign Organization Admin (bulkAssignOrganizationAdmin)
      • POST Bulk Update (bulkUpdatePermissions)
      • POST Assign Organization Admin (assignOrganizationAdmin)
      • POST Grant Collaboration (grantClientCollaborationAccess)
      • GET Organization Roles (getUserOrganizationRoles)
      • PUT Permissions (updatePermissions)
      • POST Remove Organization Admin (removeOrganizationAdmin)
      • POST Revoke Collaboration (revokeClientCollaborationAccess)
      • GET Organizations (organizations)
      • GET Statistics (statistics)
      • GET Users (index)
      • POST Bulk Assign Organization Admin (bulkAssignOrganizationAdmin)
      • POST Bulk Update (bulkUpdatePermissions)
      • POST Assign Organization Admin (assignOrganizationAdmin)
      • POST Grant Collaboration (grantClientCollaborationAccess)
      • GET Organization Roles (getUserOrganizationRoles)
      • PUT Permissions (updatePermissions)
      • POST Remove Organization Admin (removeOrganizationAdmin)
      • POST Revoke Collaboration (revokeClientCollaborationAccess)
    • REA
      • GET Agents (agents)
      • POST By Department (agentsByDepartment)
      • POST By Department Detail (agentsByDepartmentDetail)
      • GET Leaderboard (leaderboard)
      • POST Metrics (agentMetrics)
      • GET Item (availableWorkflows)
      • GET Ping (ping)
      • POST Metrics (threadMetrics)
      • GET Workflow Executions (workflowExecutions)
      • GET Workflows (workflows)
      • POST By Department (workflowsByDepartment)
      • POST By Department Detail (workflowsByDepartmentDetail)
      • POST Execution Status Count (workflowExecutionStatusCount)
      • POST Metrics (workflowMetrics)
      • GET Executions (getReaWorkflowExecutions)
      • GET Refresh (refreshWorkflowExecution)
      • GET Agents (agents)
      • POST By Department (agentsByDepartment)
      • POST By Department Detail (agentsByDepartmentDetail)
      • GET Leaderboard (leaderboard)
      • POST Metrics (agentMetrics)
      • GET Item (availableWorkflows)
      • GET Ping (ping)
      • POST Metrics (threadMetrics)
      • GET Workflow Executions (workflowExecutions)
      • GET Workflows (workflows)
      • POST By Department (workflowsByDepartment)
      • POST By Department Detail (workflowsByDepartmentDetail)
      • POST Execution Status Count (workflowExecutionStatusCount)
      • POST Metrics (workflowMetrics)
      • GET Executions (getReaWorkflowExecutions)
      • GET Refresh (refreshWorkflowExecution)
    • Get Multiplai User
      GET
    • Fetch Organizations
      GET
    • Get Global Permissions
      GET
    • Get Permissions for Tenant
      GET
    • Fetch Organizations
      GET
    • Get Global Permissions
      GET
    • Get Permissions for Tenant
      GET
  • Public
    • Public
      • GET Item (getSharedTaskBuildSteps)
      • GET Item (getSharedTaskBySlug)
      • GET Item (getSharedTaskComments)
      • GET Item (getSharedTaskSteps)
      • GET Item (getSharedTask)
      • GET Version (show)
      • POST Create (handleCreate)
      • POST Update (handleUpdate)
      • POST Attach (handleUserAttach)
      • POST Detach (handleUserDetach)
      • POST Update (handleUserUpdate)
      • POST Update (handleUserUpdate)
      • GET Item (getSharedTaskBuildSteps)
      • GET Item (getSharedTaskBySlug)
      • GET Item (getSharedTaskComments)
      • GET Item (getSharedTaskSteps)
      • GET Item (getSharedTask)
      • GET Version (show)
      • POST Create (handleCreate)
      • POST Update (handleUpdate)
      • POST Attach (handleUserAttach)
      • POST Detach (handleUserDetach)
      • POST Update (handleUserUpdate)
      • POST Update (handleUserUpdate)
  • Internal API Key
    • Internal
      • POST Generate Org Chart (generateOrgChart)
      • POST Results (storeResults)
      • GET Search (search)
      • POST Generate Org Chart (generateOrgChart)
      • POST Results (storeResults)
      • GET Search (search)
  • Multiplai Dev - Organizations
    GET
  • Multiplai Dev - Departments
    GET
  • Multiplai Dev - Organization Departments
    GET
  • Multiplai Dev - Departments Teams
    GET
  • Multiplai Dev - Organization Departments
    PUT
  • Multiplai Dev - Organization Departments Bulk
    POST
  • Multiplai Dev - Teams
    GET
  • Multiplai Dev - Organizations
    GET
  • Multiplai Dev - Departments
    GET
  • Multiplai Dev - Organization Departments
    GET
  • Multiplai Dev - Departments Teams
    GET
  • Multiplai Dev - Organization Departments
    PUT
  • Multiplai Dev - Organization Departments Bulk
    POST
  • Multiplai Dev - Teams
    GET
  1. Tenant Scoped

GET Item (show)

Developing
GET
/api/roles/{role}
Get a single role's details including its assigned permissions and users. Route-model-binds the Role by ID within the current tenant organization.
Permission: view roles

Request

Path Params

Header Params

Responses

🟢200Success
application/json
Bodyapplication/json

🟠401Unauthorized
🟠403Forbidden
🟠404Not Found
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api-dev.commandroom.ai/api/api/roles/1' \
--header 'Authorization: Bearer {{token}}' \
--header 'X-Tenant-UUID: '
Response Response Example
200 - OK
{
  "data": {
    "id": 1,
    "name": "Sample Name",
    "description": "Sample description text.",
    "guard_name": "Sample Guard Name",
    "is_default": true,
    "organization_id": 1,
    "permissions_count": 10,
    "users_count": 10,
    "permissions": [
      {
        "id": 1,
        "name": "Sample Name",
        "guard_name": "Sample Guard Name",
        "category": "string",
        "created_at": "2026-01-15T10:30:00.000000Z",
        "updated_at": "2026-01-15T10:30:00.000000Z"
      }
    ],
    "users": [
      {
        "user_id": 1,
        "goteam_id": 1,
        "name": "Sample Name",
        "email": "user@example.com",
        "avatar_url": "https://example.com/sample"
      }
    ],
    "created_at": "2026-01-15T10:30:00.000000Z",
    "updated_at": "2026-01-15T10:30:00.000000Z"
  }
}
Modified at 2026-07-02 04:47:16
Previous
GET Templates (templates)
Next
PUT Item (update)
Built with