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.
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- MOD1
- MOD2
like string requiredeq string requiredaccount_url_token object
eq string requiredcreated_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt string requiredlte string requiredgt string requiredgte string requiredupdated_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt string requiredlte string requiredgt string requiredgte 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
]
- 200
- 400
- 401
- 500
OK
- 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
- MOD4
account_name object
oneOf- MOD1
- MOD2
like stringeq stringaccount_url_token object
eq stringcreated_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt stringlte stringgt stringgte stringupdated_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt stringlte stringgt stringgte stringsorted_by object[]
The sorts applied to the returned record set.
anyOf- MOD1
- MOD2
- MOD3
updated_at stringPossible values: [
asc
,desc
]created_at stringPossible values: [
asc
,desc
]id stringPossible values: [
asc
,desc
]- records object[]
{
"start_cursor": "string",
"next_cursor": "string",
"per_page": 0,
"estimated_remaining_count": 0,
"filtered_by": [
{
"account_name": {
"like": "string"
}
},
{
"account_url_token": {
"eq": "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",
"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"
}
]
}
The format or parameters of the request was invalid
- application/json
- Schema
- Example (from schema)
Schema
errors object
typeitems 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"
}