Skip to main content

List Accounts

Allows you to see information about the corresponding account(s) related to a given API key, such as the company name and address.

info

This endpoint does not require you to pass in the Account-Token header. It does still require the API key to be passed in via the Authorization header though, as this API key is what is used to lookup the associated accounts.

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.

    • account_name object
      oneOf
    • like string required
    • account_url_token object
    • eq string required
    • created_at object
      oneOf
    • lt string required
    • updated_at object
      oneOf
    • 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

OK

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
  • account_name object
    oneOf
  • like string
  • sorted_by object[]

    The sorts applied to the returned record set.

    anyOf
  • updated_at string

    Possible values: [asc, desc]

  • records object[]
  • 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.

  • account_membership_id integer

    Possible values: >= 1

  • name string

    The name of the Account.

  • user_type string

    Possible values: [admin, owner, regular, guest]

    The membership type of the current User.

  • token string

    The URL token used to identify the Account.

  • time_24_format boolean

    Default value: false

    Whether or not this Account uses 24 hour time format.

  • currency_symbol string

    Default value: $

    The default currency symbols used by the Account.

  • city string

    The city the Account belongs to.

  • region string

    The region the Account belongs to.

  • postal_code string

    The postal code or ZIP code the Account belongs to.

  • street_address string

    The street address of the Account.

  • street_address_line_2 string

    Street address line 2 of the Account.

  • country string

    The country of the Account.

  • read_vehicles boolean

    Whether or not the Account can view Vehicles.

  • manage_vehicles boolean

    Whether or not the Account can manage Vehicles.

  • create_vehicles boolean

    Whether or not the Account can create Vehicles.

  • read_fuel_entries boolean

    Whether or not the Account can view Fuel Entries.

  • manage_fuel_entries boolean

    Whether or not the Account can manage Fuel Entries.

  • read_service_entries boolean

    Whether or not the Account can view Service Entries.

  • manage_service_entries boolean

    Whether or not the Account can manage Service Entries.

  • read_issues boolean

    Whether or not the Account can view Issues.

  • manage_issues boolean

    Whether or not the Account can manage Issues.

  • read_work_orders boolean

    Whether or not the Account can view Work Orders.

  • manage_work_orders boolean

    Whether or not the Account can manage Work Orders.

  • read_service_reminders boolean

    Whether or not the Account can view Service Reminders.

  • manage_service_reminders boolean

    Whether or not the Account can manage Service Reminders.

  • read_vehicle_renewal_reminders boolean

    Whether or not the Account can view Vehicle Renewal Reminders.

  • manage_vehicle_renewal_reminders boolean

    Whether or not the Account can manage Vehicle Renewal Reminders.

  • read_comments boolean

    Whether or not the Account can view Comments.

  • manage_comments boolean

    Whether or not the Account can manage Comments.

  • read_meter_entries boolean

    Whether or not the Account can view Meter Entries.

  • manage_meter_entries boolean

    Whether or not the Account can manage Meter Entries.

  • read_groups boolean

    Whether or not the Account can view Groups.

  • read_contacts boolean

    Whether or not the Account can view Contacts.

  • fleetio_manage boolean

    Whether or not the Account is subscribed to a Fleetio plan.

  • inspections boolean

    Whether or not the Account has inspections enabled.

  • update_parts boolean

    Whether or not the Account can update Parts.

  • update_inventory boolean

    Whether or not the Account can update inventory.

  • allowed_part_location_ids integer[]

    The Part Locations allowed to be updated.

  • new_inventory_permissions boolean

    Whether or not the Account can create new inventory.

  • plan string

    The name of the Account's currently active Subscription Plan.

  • state string

    Possible values: [trialing, assessing, active, past_due, soft_failure]

    The state of the Account's Subscription.

  • default_meter_unit string

    The default meter volume unit used by the Account.

  • default_fuel_volume_unit string

    The default fuel volume unit used by the Account.

  • default_system_of_measurement string

    Possible values: [imperial, metric]

    The default system of measurement used by the Account.

  • tax_settings object
  • tax_free_labor boolean

    Default value: false

    Configure's whether or not to include labor costs when calculating taxes. More info

  • tax_2 boolean

    Enables a secondary tax field option (Tax 2) when calculating the total amount for Work Orders and Service Entries. More info

  • default_tax_1 string

    Specify the value to be used automatically in the Tax 1 field for Work Orders and Service Entries. This is the default but this tax can be changed per record. More info

  • default_tax_2 string

    Specify the value to be used automatically in the Tax 2 field for Work Orders and Service Entries. This is the default but this tax can be changed per record. More info

  • default_tax_type string

    Possible values: [fixed, percentage]

    Specify if the default setting for charging sales tax on Work Orders and Service Entries is a fixed amount, or a percentage. This is the default but this can be changed per record. More info

  • next_work_order_number integer

    What the next Work Order's number will be in the sequence.

  • offline_inspections boolean

    Whether or not the Account can perform offline inspections.

  • inspections_new_item_type_beta boolean deprecated
  • paying_customer boolean

    Whether or not the Account is a paying customer.

  • is_demo boolean

    Whether or not the Account is in demo mode.

  • require_group boolean

    Whether or not Contacts/Users must be assigned to a Group.

  • require_a_meter_entry_on_service_entry_or_completed_work_order boolean

    Whether or not a Meter Entry is required when submitting a Service Entry or completed Work Order.

  • has_ro_notification_subscription boolean

    Whether or not the Account is subscribed to Repair Order notifications.

  • require_an_inventory_location_on_wo_part_line_items boolean

    Whether or not a Part line item on a Work Order must have a location.

  • use_forecasted_dates_for_service_reminders boolean

    Whether or not forecasted dates are used for Service Reminders.

  • require_a_rpc_on_service_entry_or_completed_work_order boolean

    Whether or not a repair priority class is required when submitting a Service Entry or completed Work Order.

  • vmrs_system_enabled boolean

    Whether or not the Vehicle Maintenance Reporting Standards system is enabled.

  • vmrs_assembly_enabled boolean

    Whether or not the VMRS assembly element identification is enabled.

  • vmrs_component_enabled boolean

    Whether or not the VMRS component identification is enabled.

  • disable_reason_for_repair_editing boolean

    Whether or not the reason for repair can be edited.

  • disable_system_assembly_component_editing boolean

    Whether or not the VMRS assembly or component information can be edited.

  • require_vmrs_reason_for_repair_on_service_line_items_as_of datetime

    The date when the VMRS reason for repair is required on service line items. If null, the VMRS reason for repair is not required.

  • require_vmrs_system_group_on_service_line_items_as_of datetime

    The date when the VMRS system group is required on service line items. If null, the VMRS system group is not required.

Loading...