> ## Documentation Index > Fetch the complete documentation index at: https://docsv4.mile.app/llms.txt > Use this file to discover all available pages before exploring further. # Read my role > Returns the role of the signed-in user, including its permission list and per-permission settings (`permissionDetails`). Every permission available to the organization is listed in `permissions`, with `access` telling whether this role has it. Any signed-in user can call it; no extra permission is needed. ## OpenAPI ````yaml /openapi/public/openapi-setting.json get /role openapi: 3.0.0 info: title: API - Setting version: 3.0.0 description: API Documentation - RESTful API for field operations management. servers: - url: https://apiweb.mile.app/api/v3 security: - bearerAuth: [] tags: - name: User description: >- User data includes information contained within a user account, such as details that define a user's hub access and role within the system. Hub access determines the locations or areas of the application a user can access or the specific actions they can perform. User attributes consist of the user ID, name, email, and status. The app provides five predefined user roles, and you can create custom roles based on your organization's needs. The predefined roles are **Owner, Admin, Planner, and Field user**. A user can only hold one role at a time but can be granted access to multiple hubs. - name: Team description: >- This API allows you to manage teams. It serves as a tool to effectively manage and restrict user task assignments within your organization. **To see the details of team object, please follow [this link](#tag/team_model)** - name: Role description: >- This API enables you to retrieve a list of predefined roles and any custom roles associated with your account. By making a GET request to this API, you can obtain information about the available roles within the system. The predefined roles refer to a set of role types that are already defined by the system. In this particular case, the predefined roles include Finance, Owner, Planner, Admin, and Field User. Additionally, the API may also return any custom roles that have been created within your account. **To see the details of role object, please follow [this link](#tag/role_model)** - name: Hub description: >- In our system, a Hub is a fundamental entity within an organization, serving as the central point for managing various operational components. It acts as the parent structure for a wide range of resources and functionalities, including tasks, visits, users, vehicles, routing results, routing configurations, and data sources. **To see the details of hub object, please follow [this link](#tag/hub_model)** ## Conceptual Understanding of Hubs - **User Perspective:** For users, a Hub represents their headquarters or primary working area. It is where they carry out their daily activities and manage their tasks effectively. Each user interacts with the Hub to access resources and perform operations specific to their roles. - **Task Perspective:** From the perspective of task management, the Hub signifies the working area for tasks. It is the location where tasks are initiated, monitored, and completed. The Hub facilitates organization and efficiency in task execution. - **Routing Perspective:** In the context of routing and logistics, a Hub serves as a critical location for vehicles. It is where vehicles begin their routes, return after completing their journeys, and may make strategic stops along the way. The routing module relies on the Hub to optimize vehicle assignments and manage routes effectively. - name: App Integration description: >- This API allows you to manage Integration of enterprise app. Currently available for Azure. **To see the details of integration object, please follow [this link](#tag/app_integration_model)** - name: Plugin description: >- The Plugin API allows developers to create and manage custom add-ons within the app. Plugins enable dynamic functionality through JavaScript resources and custom icons, allowing organizations to extend platform capabilities with custom features and integrations. **To see the details of plugin object, please follow [this link](#tag/plugin_model)** - name: Organization description: >- Organization management endpoints for configuring organization-level settings and preferences. - name: Addon description: Addon endpoints - name: Custom Module description: >- A "custom module" is like a personalized menu option in MileApp. It's something you can create and customize to make it easy to access specific features or content. - name: Password Policy description: >- Password Policy endpoints for configuring password requirements and security policies for your organization. - name: Trash description: >- Trash lists items that were deleted from your organization, so you can see what was removed and when. paths: /role: get: tags: - Role summary: Read my role description: >- Returns the role of the signed-in user, including its permission list and per-permission settings (`permissionDetails`). Every permission available to the organization is listed in `permissions`, with `access` telling whether this role has it. Any signed-in user can call it; no extra permission is needed. operationId: getOwnRole responses: '200': description: Success content: application/json: schema: type: object properties: status: type: boolean description: Status of response. data: description: Role of the signed-in user. type: object additionalProperties: true example: data: _id: 6449f8ef2c481b07d40ecfc5 name: planner isAdmin: false isDefault: true isDeleted: false permissionList: - 6156d6475320c9679e337eba - 615ac4ab5c3c0b3d3e83dfc1 permissionDetails: - permissionName: view/checkincheckout interval: null checkinRadius: null checkoutRadius: null - permissionName: add/task items: null - permissionName: view/task items: [] - permissionName: view/data items: [] permissions: - name: view/task displayName: View Task menu: Task module: mileTask type: string organizationId: system orderIndex: 1 isDeleted: false access: true meta: items: [] - name: delete/task displayName: Delete Task menu: Task module: mileTask type: string organizationId: system orderIndex: 1 isDeleted: false access: false meta: {} organizationId: 64d99303be0ad015c461c932 passwordPolicyId: null updatedTime: '2026-05-11T08:52:40.000000Z' createdTime: '2024-04-27T04:20:31.000000Z' status: true '404': description: Data not found content: application/json: schema: type: object properties: status: type: boolean description: Shows if the request was successful. message: type: string description: A short message explaining what went wrong. example: status: false message: Data not found '500': description: Server error content: application/json: schema: type: object properties: status: type: boolean description: Shows if the request was successful. message: type: string description: A short message explaining what went wrong. example: status: false message: Internal server error, please contact support@mile.app. deprecated: false security: - bearerAuth: [] components: securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: Use a valid Bearer token to authenticate. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.