--- title: "List Roles" method: GET path: "/roles" tags: ["Roles"] --- # List Roles `GET /roles` ## Request - Base URL: `https://secure.fleetio.com/api` - URL: `https://secure.fleetio.com/api/roles` - Auth: API key in header `Authorization` and API key in header `Account-Token` - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns a list of Roles belonging to your account. ## Query parameters - `start_cursor` string - `per_page` integer - `filter` object - `name` union - object - `like` string, required - object - `eq` string, required - `created_at` union - object - `lt` string, required - object - `lte` string, required - object - `gt` string, required - object - `gte` string, required - `updated_at` union - object - `lt` string, required - object - `lte` string, required - object - `gt` string, required - object - `gte` string, required - `sort` object - `id` 'asc' | 'desc' - `created_at` 'asc' | 'desc' - `updated_at` 'asc' | 'desc' ## Response `200` OK - object - `start_cursor` string, nullable: The current start cursor of the records returned. - `next_cursor` string, nullable: The next cursor to retrieve the next page of records. - `per_page` integer: The maximum number of records returned. - `estimated_remaining_count` integer: The number of remaining records including the returned records, up to a maximum of 500. - `filtered_by` union[]: The filters applied to the returned record set. - union - object - `name` union - object - `like` string, required - object - `eq` string, required - object - `created_at` union - object - `lt` string, required - object - `lte` string, required - object - `gt` string, required - object - `gte` string, required - object - `updated_at` union - object - `lt` string, required - object - `lte` string, required - object - `gt` string, required - object - `gte` string, required - `sorted_by` union[]: The sorts applied to the returned record set. - union - object - `updated_at` 'asc' | 'desc' - object - `created_at` 'asc' | 'desc' - object - `id` 'asc' | 'desc' - `records` Role[] - `id` integer - `created_at` string, date-time, required: The date and time at which this record was created. - `updated_at` string, date-time, required: The date and time at which this record was most recently updated. - `name` string, required: The name of this Role. - `description` string, nullable, required: The description of this Role. - `default` boolean, required: Whether this Role is applied as the default Role for new `Users`. - `type` 'StandardRole' | 'CustomRole', required: Indicates whether this role is a standard Fleetio role, or created by a user. - `module_access` RoleModuleAccess, required - `contact_renewal_reminders_access` 'full' | 'some' | 'none' - `contacts_access` 'full' | 'some' | 'none' - `dashboards_access` 'full' | 'some' | 'none' - `documents_access` 'full' | 'some' | 'none' - `equipments_access` 'full' | 'some' | 'none' - `expense_entries_access` 'full' | 'some' | 'none' - `faults_access` 'full' | 'some' | 'none' - `fuel_entries_access` 'full' | 'some' | 'none' - `inspections_access` 'full' | 'some' | 'none' - `integrations_access` 'full' | 'some' | 'none' - `issues_access` 'full' | 'some' | 'none' - `location_entries_access` 'full' | 'some' | 'none' - `meter_entries_access` 'full' | 'some' | 'none' - `msi_access` 'full' | 'some' | 'none' - `parts_inventory_access` 'full' | 'some' | 'none' - `places_access` 'full' | 'some' | 'none' - `purchase_orders_access` 'full' | 'some' | 'none' - `recalls_access` 'full' | 'some' | 'none' - `reports_access` 'full' | 'some' | 'none' - `service_entries_access` 'full' | 'some' | 'none' - `service_programs_access` 'full' | 'some' | 'none' - `service_reminders_access` 'full' | 'some' | 'none' - `service_task_management_access` 'full' | 'some' | 'none' - `vehicle_renewal_reminders_access` 'full' | 'some' | 'none' - `vehicles_access` 'full' | 'some' | 'none' - `vendors_access` 'full' | 'some' | 'none' - `work_orders_access` 'full' | 'some' | 'none' - `module_permissions` RoleModulePermissions, required - `vehicles_create` boolean - `vehicles_edit` boolean - `vehicles_archive_delete` boolean - `vehicles_update_status` boolean - `vehicles_manage_vehicle_assignment` boolean - `vehicles_view_details` boolean - `vehicles_view_financial_info` boolean - `vehicles_view_custom_fields` boolean - `vehicles_view_documents` boolean - `vehicles_manage_documents` boolean - `vehicles_manage_photos` boolean - `vehicles_export_data` boolean - `equipments_create` boolean - `equipments_view_details` boolean - `equipments_view_financial_info` boolean - `equipments_view_custom_fields` boolean - `equipments_export_data` boolean - `equipments_view_documents` boolean - `equipments_manage_documents` boolean - `equipments_manage_photos` boolean - `equipments_archive_delete` boolean - `equipments_edit` boolean - `equipments_update_status` boolean - `equipments_manage_assignments` boolean - `meter_entries_create` boolean - `meter_entries_view` boolean - `meter_entries_export_data` boolean - `meter_entries_edit` boolean - `meter_entries_delete` boolean - `fuel_entries_create` boolean - `fuel_entries_view` boolean - `fuel_entries_export_data` boolean - `fuel_entries_edit` boolean - `fuel_entries_delete` boolean - `issues_create` boolean - `issues_view_open` boolean - `issues_view_resolved_or_closed` boolean - `issues_export_data` boolean - `issues_edit` boolean - `issues_delete` boolean - `issues_view_documents` boolean - `issues_manage_documents` boolean - `faults_view` boolean - `faults_export_data` boolean - `faults_ignore_codes` boolean - `recalls_view` boolean - `recalls_export_data` boolean - `recalls_ignore` boolean - `service_tasks_create` boolean - `service_tasks_edit` boolean - `service_tasks_archive_delete` boolean - `service_entries_create` boolean - `service_entries_view` boolean - `service_entries_view_update_cost_information` boolean - `service_entries_export_data` boolean - `service_entries_edit` boolean - `service_entries_delete` boolean - `service_entries_view_documents` boolean - `service_entries_manage_documents` boolean - `work_orders_create` boolean - `work_orders_view_incomplete` boolean - `work_orders_view_completed` boolean - `work_orders_view_update_cost_information` boolean - `work_orders_export_data` boolean - `work_orders_edit` boolean - `work_orders_edit_number` boolean - `work_orders_manage_labor_time_entries` boolean - `work_orders_delete` boolean - `work_orders_view_documents` boolean - `work_orders_manage_documents` boolean - `inspections_manage_inspection_forms` boolean - `inspections_manage_schedules` boolean - `inspections_submit_inspections` boolean - `inspections_view_submissions` boolean - `inspections_export_data` boolean - `inspections_edit_submissions` boolean - `inspections_delete_submissions` boolean - `msi_manage_payment_profile` boolean - `msi_manage_ro_notifications` boolean - `msi_view_account_details` boolean - `msi_view_account_summary` boolean - `msi_view_repair_order_notifications` boolean - `msi_view_statements` boolean - `msi_view_transactions` boolean - `service_reminders_create` boolean - `service_reminders_view` boolean - `service_reminders_export_data` boolean - `service_reminders_edit` boolean - `service_reminders_delete` boolean - `service_programs_create_update` boolean - `service_programs_view` boolean - `vehicle_renewal_reminders_create` boolean - `vehicle_renewal_reminders_view` boolean - `vehicle_renewal_reminders_export_data` boolean - `vehicle_renewal_reminders_edit` boolean - `vehicle_renewal_reminders_delete` boolean - `contacts_create` boolean - `contacts_edit` boolean - `contacts_view_basic_info` boolean - `contacts_view_contact_and_personal_info` boolean - `contacts_view_custom_fields` boolean - `contacts_export_data` boolean - `contacts_archive_delete` boolean - `contacts_view_documents` boolean - `contacts_manage_documents` boolean - `contacts_manage_photos` boolean - `contact_renewal_reminders_create` boolean - `contact_renewal_reminders_view` boolean - `contact_renewal_reminders_export_data` boolean - `contact_renewal_reminders_edit` boolean - `contact_renewal_reminders_delete` boolean - `vendors_create` boolean - `vendors_view` boolean - `vendors_export_data` boolean - `vendors_edit` boolean - `vendors_delete` boolean - `vendors_view_documents` boolean - `vendors_manage_documents` boolean - `vendors_manage_photos` boolean - `parts_inventory_create_parts` boolean - `parts_inventory_edit_parts` boolean - `parts_inventory_update_inventory_quantities` boolean - `parts_inventory_view_part_details` boolean - `parts_inventory_view_part_activity` boolean - `parts_inventory_export_data` boolean - `parts_inventory_archive_delete_parts` boolean - `parts_inventory_view_documents` boolean - `parts_inventory_manage_documents` boolean - `purchase_orders_create_update` boolean - `purchase_orders_delete` boolean - `purchase_orders_view` boolean - `purchase_orders_export_data` boolean - `purchase_orders_receive` boolean - `purchase_orders_approve` boolean - `reports_vehicles` boolean - `reports_contacts` boolean - `reports_parts` boolean - `reports_view_external_reports` boolean - `reports_shared` boolean - `places_create` boolean - `places_view` boolean - `places_export_data` boolean - `places_edit` boolean - `places_delete` boolean - `location_entries_create` boolean - `location_entries_view` boolean - `location_entries_edit` boolean - `location_entries_delete` boolean - `expense_entries_create` boolean - `expense_entries_view` boolean - `expense_entries_export_data` boolean - `expense_entries_edit` boolean - `expense_entries_delete` boolean - `dashboards_manage` boolean - `dashboards_share` boolean - `documents_view_global_documents` boolean - `documents_manage_global_documents` boolean - `gps_manage_devices` boolean ## Other responses - `400`: The format or parameters of the request was invalid - `401`: Request could not be authenticated - `500`: Something unexpected happened ## Changes - **2026-11-06** `49558d744bd7`: 1 info - for the `query` request parameter `per_page`, the min was decreased from `2.00` to `1.00` [Operation history](https://skmtc.dev/fleetio/apis/fleetio-developer-api/changes/roles/get.md) --- [API](https://skmtc.dev/fleetio/apis/fleetio-developer-api.md) - [All operations](https://skmtc.dev/fleetio/apis/fleetio-developer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fleetio/apis/fleetio-developer-api/revisions/49558d744bd7?raw)