List Roles

Returns a list of Roles belonging to your account.

Query Parameters

start_cursor string
The start cursor for Keyset pagination.
per_page integer
Possible values: >= 2 and <= 100
Default value: 50
The number of records per page to return.
filter object
The fields, operations, and values to filter the records by.
- name object
  oneOf
  MOD1
  MOD2
  like string required
- created_at object
  oneOf
  MOD1
  MOD2
  MOD3
  MOD4
  lt string required
- updated_at object
  oneOf
  MOD1
  MOD2
  MOD3
  MOD4
  lt string required
sort object
The fields and direction to sort the results by.
- id string
  Possible values: [asc, desc]
  Default value: desc
- created_at string
  Possible values: [asc, desc]
- updated_at string
  Possible values: [asc, desc]

Responses

application/json

Schema
Example (from schema)

Schema

start_cursor string
The current start cursor of the records returned.
next_cursor string
The next cursor to retrieve the next page of records.
per_page integer
The maxumum 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 object[]
The filters applied to the returned record set.
anyOf
MOD1
MOD2
MOD3
name object
oneOf
MOD1
MOD2
like string
sorted_by object[]
The sorts applied to the returned record set.
anyOf
MOD1
MOD2
MOD3
updated_at string
Possible values: [asc, desc]
records object[]

{
  "start_cursor": "string",
  "next_cursor": "string",
  "per_page": 0,
  "estimated_remaining_count": 0,
  "filtered_by": [
    {
      "name": {
        "like": "string"
      }
    },
    {
      "created_at": {
        "lt": "string"
      }
    },
    {
      "updated_at": {
        "lt": "string"
      }
    }
  ],
  "sorted_by": [
    {
      "updated_at": "asc"
    },
    {
      "created_at": "asc"
    },
    {
      "id": "asc"
    }
  ],
  "records": [
    {
      "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
      }
    }
  ]
}

The format or parameters of the request was invalid

application/json

Schema
Example (from schema)

Schema

errors object
type
items string

{
  "errors": {}
}

Request could not be authenticated

application/json

Schema
Example (from schema)

Schema

status integer
Possible values: >= 400 and <= 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: >= 400 and <= 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"
}