List Accounts

GET 
https://secure.fleetio.com/api/v1/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.

Request

Responses

200

OK

Response Headers

X-PaginationLimit

The per page limit. Currently set to 100 but subject to change at any time.

X-Pagination-Current-Page

The current page. Defaults to 1.

X-Pagination-Total-Pages

The total number of pages in the result set. Use this along with Pagination-Current-Page to determine if there are any remaining pages/records to be retrieved.

X-Pagination-Total-Count

The total number of records in the result set (across all pages).

application/json

Schema

Schema

Array [
idinteger
Possible values: >= 1
created_atdate-time
The date and time at which this record was created.
Example: 2023-03-14T13:46:27-06:00
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
account_membership_idId (integer)
Possible values: >= 1
namestringrequired
The name of the Account.
user_typestringrequired
The membership type of the current User.
Possible values: [admin, owner, regular, guest]
tokenstringrequired
The URL token used to identify the Account.
time_24_formatbooleanrequired
Whether or not this Account uses 24 hour time format.
Default value: false
currency_symbolstringrequired
The default currency symbols used by the Account.
Default value: $
citystringnullablerequired
The city the Account belongs to.
regionstringnullablerequired
The region the Account belongs to.
postal_codestringnullablerequired
The postal code or ZIP code the Account belongs to.
street_addressstringnullablerequired
The street address of the Account.
street_address_line_2stringnullable
Street address line 2 of the Account.
countrystringnullablerequired
The country of the Account.
read_vehiclesbooleanrequired
Whether or not the Account can view Vehicles.
manage_vehiclesbooleanrequired
Whether or not the Account can manage Vehicles.
create_vehiclesbooleanrequired
Whether or not the Account can create Vehicles.
read_fuel_entriesbooleanrequired
Whether or not the Account can view Fuel Entries.
manage_fuel_entriesbooleanrequired
Whether or not the Account can manage Fuel Entries.
read_service_entriesbooleanrequired
Whether or not the Account can view Service Entries.
manage_service_entriesbooleanrequired
Whether or not the Account can manage Service Entries.
read_issuesbooleanrequired
Whether or not the Account can view Issues.
manage_issuesbooleanrequired
Whether or not the Account can manage Issues.
read_work_ordersbooleanrequired
Whether or not the Account can view Work Orders.
manage_work_ordersbooleanrequired
Whether or not the Account can manage Work Orders.
read_service_remindersbooleanrequired
Whether or not the Account can view Service Reminders.
manage_service_remindersbooleanrequired
Whether or not the Account can manage Service Reminders.
read_vehicle_renewal_remindersbooleanrequired
Whether or not the Account can view Vehicle Renewal Reminders.
manage_vehicle_renewal_remindersbooleanrequired
Whether or not the Account can manage Vehicle Renewal Reminders.
read_commentsbooleanrequired
Whether or not the Account can view Comments.
manage_commentsbooleanrequired
Whether or not the Account can manage Comments.
read_meter_entriesbooleanrequired
Whether or not the Account can view Meter Entries.
manage_meter_entriesbooleanrequired
Whether or not the Account can manage Meter Entries.
read_groupsbooleanrequired
Whether or not the Account can view Groups.
read_contactsbooleanrequired
Whether or not the Account can view Contacts.
fleetio_managebooleanrequired
Whether or not the Account is subscribed to a Fleetio plan.
inspectionsbooleanrequired
Whether or not the Account has inspections enabled.
update_partsbooleanrequired
Whether or not the Account can update Parts.
update_inventorybooleanrequired
Whether or not the Account can update inventory.
allowed_part_location_idsinteger[]required
The Part Locations allowed to be updated.
new_inventory_permissionsbooleanrequired
Whether or not the Account can create new inventory.
planstringrequired
The name of the Account's currently active Subscription Plan.
statestringrequired
The state of the Account's Subscription.
Possible values: [trialing, assessing, active, past_due, soft_failure]
default_meter_unitstringnullablerequired
The default meter volume unit used by the Account.
default_fuel_volume_unitstringnullablerequired
The default fuel volume unit used by the Account.
default_system_of_measurementstringnullablerequired
The default system of measurement used by the Account.
Possible values: [imperial, metric]
tax_settings objectrequired
tax_free_laborbooleannullable
Configure's whether or not to include labor costs when calculating taxes. More info
Default value: false
tax_2booleannullable
Enables a secondary tax field option (Tax 2) when calculating the total amount for Work Orders and Service Entries. More info
default_tax_1stringnullable
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_2stringnullable
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_typestringnullable
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
Possible values: [fixed, percentage]
next_work_order_numberintegerrequired
What the next Work Order's number will be in the sequence.
offline_inspectionsbooleannullablerequired
Whether or not the Account can perform offline inspections.
inspections_new_item_type_betabooleannullablerequireddeprecated
paying_customerbooleannullablerequired
Whether or not the Account is a paying customer.
is_demobooleannullablerequired
Whether or not the Account is in demo mode.
require_groupbooleannullablerequired
Whether or not Contacts/Users must be assigned to a Group.
require_a_meter_entry_on_service_entry_or_completed_work_orderbooleannullablerequired
Whether or not a Meter Entry is required when submitting a Service Entry or completed Work Order.
has_ro_notification_subscriptionbooleannullablerequired
Whether or not the Account is subscribed to Repair Order notifications.
require_an_inventory_location_on_wo_part_line_itemsbooleannullablerequired
Whether or not a Part line item on a Work Order must have a location.
use_forecasted_dates_for_service_remindersbooleannullablerequired
Whether or not forecasted dates are used for Service Reminders.
require_a_rpc_on_service_entry_or_completed_work_orderbooleannullablerequired
Whether or not a repair priority class is required when submitting a Service Entry or completed Work Order.
vmrs_system_enabledbooleannullablerequired
Whether or not the Vehicle Maintenance Reporting Standards system is enabled.
vmrs_assembly_enabledbooleannullablerequired
Whether or not the VMRS assembly element identification is enabled.
vmrs_component_enabledbooleannullablerequired
Whether or not the VMRS component identification is enabled.
disable_reason_for_repair_editingbooleannullablerequired
Whether or not the reason for repair can be edited.
disable_system_assembly_component_editingbooleannullablerequired
Whether or not the VMRS assembly or component information can be edited.
require_vmrs_reason_for_repair_on_service_line_items_as_ofdatetimenullablerequired
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_ofdatetimenullablerequired
The date when the VMRS system group is required on service line items. If null, the VMRS system group is not required.
]

Example (auto)

[
  {
    "id": 0,
    "created_at": "2023-03-14T13:46:27-06:00",
    "updated_at": "2023-03-14T13:46:27-06:00",
    "account_membership_id": 0,
    "name": "string",
    "user_type": "admin",
    "token": "string",
    "time_24_format": false,
    "currency_symbol": "$",
    "city": "string",
    "region": "string",
    "postal_code": "string",
    "street_address": "string",
    "street_address_line_2": "string",
    "country": "string",
    "read_vehicles": true,
    "manage_vehicles": true,
    "create_vehicles": true,
    "read_fuel_entries": true,
    "manage_fuel_entries": true,
    "read_service_entries": true,
    "manage_service_entries": true,
    "read_issues": true,
    "manage_issues": true,
    "read_work_orders": true,
    "manage_work_orders": true,
    "read_service_reminders": true,
    "manage_service_reminders": true,
    "read_vehicle_renewal_reminders": true,
    "manage_vehicle_renewal_reminders": true,
    "read_comments": true,
    "manage_comments": true,
    "read_meter_entries": true,
    "manage_meter_entries": true,
    "read_groups": true,
    "read_contacts": true,
    "fleetio_manage": true,
    "inspections": true,
    "update_parts": true,
    "update_inventory": true,
    "allowed_part_location_ids": [
      0
    ],
    "new_inventory_permissions": true,
    "plan": "string",
    "state": "trialing",
    "default_meter_unit": "string",
    "default_fuel_volume_unit": "string",
    "default_system_of_measurement": "imperial",
    "tax_settings": {
      "tax_free_labor": false,
      "tax_2": true,
      "default_tax_1": "string",
      "default_tax_2": "string",
      "default_tax_type": "fixed"
    },
    "next_work_order_number": 0,
    "offline_inspections": true,
    "paying_customer": true,
    "is_demo": true,
    "require_group": true,
    "require_a_meter_entry_on_service_entry_or_completed_work_order": true,
    "has_ro_notification_subscription": true,
    "require_an_inventory_location_on_wo_part_line_items": true,
    "use_forecasted_dates_for_service_reminders": true,
    "require_a_rpc_on_service_entry_or_completed_work_order": true,
    "vmrs_system_enabled": true,
    "vmrs_assembly_enabled": true,
    "vmrs_component_enabled": true,
    "disable_reason_for_repair_editing": true,
    "disable_system_assembly_component_editing": true,
    "require_vmrs_reason_for_repair_on_service_line_items_as_of": "string",
    "require_vmrs_system_group_on_service_line_items_as_of": "string"
  }
]

401

Request could not be authenticated

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

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.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

500

Something unexpected happened

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

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.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: Prefix the value with "Token", for example: "Token 76cbe06c49a64".
You can generate a new API key [here](https://secure.fleetio.com/api_keys).

name: Account-Tokentype: apiKeyin: headerdescription: You can find your Account-Token [here](https://secure.fleetio.com/api_keys)

• curl
• ruby
• python
• csharp
• go
• java
• nodejs
• php

• CURL

curl -L 'https://secure.fleetio.com/api/v1/accounts' \
-H 'Accept: application/json' \
-H 'Authorization: Token <Authorization>' \
-H 'Account-Token: <Authorization>'

Request Collapse all

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

ResponseClear

Click the Send API Request button above and see the response here!