Retrieve Role
Retrieve the details of an existing Role.
Path Parameters
- id string required
Possible values: Value must match regular expression
^[0-9]+$The id of the relevant record
- 200
- 401
- 403
- 404
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
- id integer
Possible values:
>= 1 - created_at date-time
The date and time at which this record was created.
- updated_at date-time
The date and time at which this record was most recently updated.
- name string
The name of this Role.
- description string
The description of this Role.
- default boolean
Whether this Role is applied as the default Role for new
Users. - type string
Possible values: [
StandardRole,CustomRole]Indicates whether this role is a standard Fleetio role, or created by a user.
module_access object
contact_renewal_reminders_access stringPossible values: [
full,some,none]Default value:
nonecontacts_access stringPossible values: [
full,some,none]Default value:
nonedashboards_access stringPossible values: [
full,some,none]Default value:
nonedocuments_access stringPossible values: [
full,some,none]Default value:
noneequipments_access stringPossible values: [
full,some,none]Default value:
noneexpense_entries_access stringPossible values: [
full,some,none]Default value:
nonefaults_access stringPossible values: [
full,some,none]Default value:
nonefuel_entries_access stringPossible values: [
full,some,none]Default value:
noneinspections_access stringPossible values: [
full,some,none]Default value:
noneintegrations_access stringPossible values: [
full,some,none]Default value:
noneissues_access stringPossible values: [
full,some,none]Default value:
nonelocation_entries_access stringPossible values: [
full,some,none]Default value:
nonemeter_entries_access stringPossible values: [
full,some,none]Default value:
nonemsi_access stringPossible values: [
full,some,none]Default value:
noneparts_inventory_access stringPossible values: [
full,some,none]Default value:
noneplaces_access stringPossible values: [
full,some,none]Default value:
nonepurchase_orders_access stringPossible values: [
full,some,none]Default value:
nonerecalls_access stringPossible values: [
full,some,none]Default value:
nonereports_access stringPossible values: [
full,some,none]Default value:
noneservice_entries_access stringPossible values: [
full,some,none]Default value:
noneservice_programs_access stringPossible values: [
full,some,none]Default value:
noneservice_reminders_access stringPossible values: [
full,some,none]Default value:
noneservice_task_management_access stringPossible values: [
full,some,none]Default value:
nonevehicle_renewal_reminders_access stringPossible values: [
full,some,none]Default value:
nonevehicles_access stringPossible values: [
full,some,none]Default value:
nonevendors_access stringPossible values: [
full,some,none]Default value:
nonework_orders_access stringPossible values: [
full,some,none]Default value:
nonemodule_permissions object
vehicles_create booleanvehicles_edit booleanvehicles_archive_delete booleanvehicles_update_status booleanvehicles_manage_vehicle_assignment booleanvehicles_view_details booleanvehicles_view_financial_info booleanvehicles_view_custom_fields booleanvehicles_view_documents booleanvehicles_manage_documents booleanvehicles_manage_photos booleanvehicles_export_data booleanequipments_create booleanequipments_view_details booleanequipments_view_financial_info booleanequipments_view_custom_fields booleanequipments_export_data booleanequipments_view_documents booleanequipments_manage_documents booleanequipments_manage_photos booleanequipments_archive_delete booleanequipments_edit booleanequipments_update_status booleanequipments_manage_assignments booleanmeter_entries_create booleanmeter_entries_view booleanmeter_entries_export_data booleanmeter_entries_edit booleanmeter_entries_delete booleanfuel_entries_create booleanfuel_entries_view booleanfuel_entries_export_data booleanfuel_entries_edit booleanfuel_entries_delete booleanissues_create booleanissues_view_open booleanissues_view_resolved_or_closed booleanissues_export_data booleanissues_edit booleanissues_delete booleanissues_view_documents booleanissues_manage_documents booleanfaults_view booleanfaults_export_data booleanfaults_ignore_codes booleanrecalls_view booleanrecalls_export_data booleanrecalls_ignore booleanservice_tasks_create booleanservice_tasks_edit booleanservice_tasks_archive_delete booleanservice_entries_create booleanservice_entries_view booleanservice_entries_view_update_cost_information booleanservice_entries_export_data booleanservice_entries_edit booleanservice_entries_delete booleanservice_entries_view_documents booleanservice_entries_manage_documents booleanwork_orders_create booleanwork_orders_view_incomplete booleanwork_orders_view_completed booleanwork_orders_view_update_cost_information booleanwork_orders_export_data booleanwork_orders_edit booleanwork_orders_manage_labor_time_entries booleanwork_orders_delete booleanwork_orders_view_documents booleanwork_orders_manage_documents booleaninspections_manage_inspection_forms booleaninspections_manage_schedules booleaninspections_submit_inspections booleaninspections_view_submissions booleaninspections_export_data booleaninspections_edit_submissions booleaninspections_delete_submissions booleanmsi_manage_payment_profile booleanmsi_view_account_details booleanmsi_view_account_summary booleanmsi_view_statements booleanmsi_view_transactions booleanservice_reminders_create booleanservice_reminders_view booleanservice_reminders_export_data booleanservice_reminders_edit booleanservice_reminders_delete booleanservice_programs_create_update booleanservice_programs_view booleanvehicle_renewal_reminders_create booleanvehicle_renewal_reminders_view booleanvehicle_renewal_reminders_export_data booleanvehicle_renewal_reminders_edit booleanvehicle_renewal_reminders_delete booleancontacts_create booleancontacts_edit booleancontacts_view_basic_info booleancontacts_view_contact_and_personal_info booleancontacts_view_custom_fields booleancontacts_export_data booleancontacts_archive_delete booleancontacts_view_documents booleancontacts_manage_documents booleancontacts_manage_photos booleancontact_renewal_reminders_create booleancontact_renewal_reminders_view booleancontact_renewal_reminders_export_data booleancontact_renewal_reminders_edit booleancontact_renewal_reminders_delete booleanvendors_create booleanvendors_view booleanvendors_export_data booleanvendors_edit booleanvendors_delete booleanvendors_view_documents booleanvendors_manage_documents booleanvendors_manage_photos booleanparts_inventory_create_parts booleanparts_inventory_edit_parts booleanparts_inventory_update_inventory_quantities booleanparts_inventory_view_part_details booleanparts_inventory_view_part_activity booleanparts_inventory_export_data booleanparts_inventory_archive_delete_parts booleanparts_inventory_view_documents booleanparts_inventory_manage_documents booleanpurchase_orders_create_update booleanpurchase_orders_delete booleanpurchase_orders_view booleanpurchase_orders_export_data booleanpurchase_orders_receive booleanpurchase_orders_approve booleanreports_vehicles booleanreports_contacts booleanreports_parts booleanreports_view_external_reports booleanreports_shared booleanplaces_create booleanplaces_view booleanplaces_export_data booleanplaces_edit booleanplaces_delete booleanlocation_entries_create booleanlocation_entries_view booleanlocation_entries_edit booleanlocation_entries_delete booleanexpense_entries_create booleanexpense_entries_view booleanexpense_entries_export_data booleanexpense_entries_edit booleanexpense_entries_delete booleandashboards_manage booleandashboards_share booleandocuments_view_global_documents booleandocuments_manage_global_documents booleangps_manage_devices boolean
{
"id": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00",
"name": "string",
"description": "string",
"default": true,
"type": "StandardRole",
"module_access": {
"contact_renewal_reminders_access": "none",
"contacts_access": "none",
"dashboards_access": "none",
"documents_access": "none",
"equipments_access": "none",
"expense_entries_access": "none",
"faults_access": "none",
"fuel_entries_access": "none",
"inspections_access": "none",
"integrations_access": "none",
"issues_access": "none",
"location_entries_access": "none",
"meter_entries_access": "none",
"msi_access": "none",
"parts_inventory_access": "none",
"places_access": "none",
"purchase_orders_access": "none",
"recalls_access": "none",
"reports_access": "none",
"service_entries_access": "none",
"service_programs_access": "none",
"service_reminders_access": "none",
"service_task_management_access": "none",
"vehicle_renewal_reminders_access": "none",
"vehicles_access": "none",
"vendors_access": "none",
"work_orders_access": "none"
},
"module_permissions": {
"vehicles_create": true,
"vehicles_edit": true,
"vehicles_archive_delete": true,
"vehicles_update_status": true,
"vehicles_manage_vehicle_assignment": true,
"vehicles_view_details": true,
"vehicles_view_financial_info": true,
"vehicles_view_custom_fields": true,
"vehicles_view_documents": true,
"vehicles_manage_documents": true,
"vehicles_manage_photos": true,
"vehicles_export_data": true,
"equipments_create": true,
"equipments_view_details": true,
"equipments_view_financial_info": true,
"equipments_view_custom_fields": true,
"equipments_export_data": true,
"equipments_view_documents": true,
"equipments_manage_documents": true,
"equipments_manage_photos": true,
"equipments_archive_delete": true,
"equipments_edit": true,
"equipments_update_status": true,
"equipments_manage_assignments": true,
"meter_entries_create": true,
"meter_entries_view": true,
"meter_entries_export_data": true,
"meter_entries_edit": true,
"meter_entries_delete": true,
"fuel_entries_create": true,
"fuel_entries_view": true,
"fuel_entries_export_data": true,
"fuel_entries_edit": true,
"fuel_entries_delete": true,
"issues_create": true,
"issues_view_open": true,
"issues_view_resolved_or_closed": true,
"issues_export_data": true,
"issues_edit": true,
"issues_delete": true,
"issues_view_documents": true,
"issues_manage_documents": true,
"faults_view": true,
"faults_export_data": true,
"faults_ignore_codes": true,
"recalls_view": true,
"recalls_export_data": true,
"recalls_ignore": true,
"service_tasks_create": true,
"service_tasks_edit": true,
"service_tasks_archive_delete": true,
"service_entries_create": true,
"service_entries_view": true,
"service_entries_view_update_cost_information": true,
"service_entries_export_data": true,
"service_entries_edit": true,
"service_entries_delete": true,
"service_entries_view_documents": true,
"service_entries_manage_documents": true,
"work_orders_create": true,
"work_orders_view_incomplete": true,
"work_orders_view_completed": true,
"work_orders_view_update_cost_information": true,
"work_orders_export_data": true,
"work_orders_edit": true,
"work_orders_manage_labor_time_entries": true,
"work_orders_delete": true,
"work_orders_view_documents": true,
"work_orders_manage_documents": true,
"inspections_manage_inspection_forms": true,
"inspections_manage_schedules": true,
"inspections_submit_inspections": true,
"inspections_view_submissions": true,
"inspections_export_data": true,
"inspections_edit_submissions": true,
"inspections_delete_submissions": true,
"msi_manage_payment_profile": true,
"msi_view_account_details": true,
"msi_view_account_summary": true,
"msi_view_statements": true,
"msi_view_transactions": true,
"service_reminders_create": true,
"service_reminders_view": true,
"service_reminders_export_data": true,
"service_reminders_edit": true,
"service_reminders_delete": true,
"service_programs_create_update": true,
"service_programs_view": true,
"vehicle_renewal_reminders_create": true,
"vehicle_renewal_reminders_view": true,
"vehicle_renewal_reminders_export_data": true,
"vehicle_renewal_reminders_edit": true,
"vehicle_renewal_reminders_delete": true,
"contacts_create": true,
"contacts_edit": true,
"contacts_view_basic_info": true,
"contacts_view_contact_and_personal_info": true,
"contacts_view_custom_fields": true,
"contacts_export_data": true,
"contacts_archive_delete": true,
"contacts_view_documents": true,
"contacts_manage_documents": true,
"contacts_manage_photos": true,
"contact_renewal_reminders_create": true,
"contact_renewal_reminders_view": true,
"contact_renewal_reminders_export_data": true,
"contact_renewal_reminders_edit": true,
"contact_renewal_reminders_delete": true,
"vendors_create": true,
"vendors_view": true,
"vendors_export_data": true,
"vendors_edit": true,
"vendors_delete": true,
"vendors_view_documents": true,
"vendors_manage_documents": true,
"vendors_manage_photos": true,
"parts_inventory_create_parts": true,
"parts_inventory_edit_parts": true,
"parts_inventory_update_inventory_quantities": true,
"parts_inventory_view_part_details": true,
"parts_inventory_view_part_activity": true,
"parts_inventory_export_data": true,
"parts_inventory_archive_delete_parts": true,
"parts_inventory_view_documents": true,
"parts_inventory_manage_documents": true,
"purchase_orders_create_update": true,
"purchase_orders_delete": true,
"purchase_orders_view": true,
"purchase_orders_export_data": true,
"purchase_orders_receive": true,
"purchase_orders_approve": true,
"reports_vehicles": true,
"reports_contacts": true,
"reports_parts": true,
"reports_view_external_reports": true,
"reports_shared": true,
"places_create": true,
"places_view": true,
"places_export_data": true,
"places_edit": true,
"places_delete": true,
"location_entries_create": true,
"location_entries_view": true,
"location_entries_edit": true,
"location_entries_delete": true,
"expense_entries_create": true,
"expense_entries_view": true,
"expense_entries_export_data": true,
"expense_entries_edit": true,
"expense_entries_delete": true,
"dashboards_manage": true,
"dashboards_share": true,
"documents_view_global_documents": true,
"documents_manage_global_documents": true,
"gps_manage_devices": true
}
}
Request could not be authenticated
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400and<= 599 - title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
Insufficient permission to perform this operation
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400and<= 599 - title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
The requested resource could not be located
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400and<= 599 - title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
Something unexpected happened
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400and<= 599 - title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}