View the permissions of a user role

Purpose: Use this API to view all the available permissions pertaining to a user's role such as an admin, or a fleet manager, or a driver. This API will list out all the available permissions to that particular user role.

📘

NOTE

You must specify the name and the status of the role to view its associated permissions in the Query Parameters. Refer to the query parameters section for more info.

Response Parameters

id

• Type: Integer
• Description: The unique identifier for the user role.

name

• Type: String
• Description: The name of the user role.

permissions

• Type: Array of Strings
• Description: List of permissions granted to the user role.

status

• Type: String
• Description: The status of the user role (e.g., active).

created_at

• Type: String (DateTime)
• Description: The date and time when the user role was created.

updated_at

• Type: String (DateTime)
• Description: The date and time when the user role was last updated.

last_edited_by

• Type: Object
• Description: Information about the user who last edited the role.

id

• Type: Integer
• Description: The unique identifier of the user who last edited.

first_name

• Type: String
• Description: The first name of the user who last edited.

last_name

• Type: String
• Description: The last name of the user who last edited.

is_editable

• Type: Boolean
• Description: Indicates whether the user role can be edited.

type

• Type: String
• Description: The type of the user role (e.g., default or custom).

assigned_users_count

• Type: Integer
• Description: The number of users assigned to this role.