List Vendors

GET 
https://secure.fleetio.com/api/v1/vendors

Returns a list of Vendors belonging to your account.

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 [
idId (integer)required
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
namestringrequired
The name of the Vendor.
phonestringnullablerequired
The phone number of the Vendor.
street_addressstringnullablerequired
The street address of the Vendor.
street_address_line_2stringnullablerequired
The second line of the street address of the Vendor.
citystringnullablerequired
The city of the Vendor.
regionstringnullablerequired
The region, state, province, or territory of the Vendor.
postal_codestringnullablerequired
The postal code or ZIP code of the Vendor.
countrystringnullablerequired
The country of the Vendor.
websitestringnullablerequired
The website of the Vendor.
notesstringnullablerequired
Additional notes about the Vendor.
fuelbooleannullablerequired
Indicates whether the Vendor provides fuel.
servicebooleannullablerequired
Indicates whether the Vendor provides service.
partsbooleannullablerequired
Indicates whether the Vendor provides parts.
vehiclebooleannullablerequired
Indicates whether the Vendor provides vehicles.
contact_namestringnullablerequired
The name of the contact person for the Vendor.
contact_emailstringnullablerequired
The email address of the contact person for the Vendor.
contact_phonestringnullablerequired
The phone number of the contact person for the Vendor.
latitudefloatnullablerequired
The latitude of the Vendor's location.
longitudefloatnullablerequired
The longitude of the Vendor's location.
external_idstringnullablerequired
The external identifier of the Vendor.
archived_atstringnullablerequired
The date and time when the Vendor was archived, if applicable.
labels object[]required
Array [
idId (integer)
Possible values: >= 1
namestring
]
custom_fieldsobjectnullablerequired
*Full details on working with Custom Fields here.
]

Example (auto)

[
  {
    "id": 0,
    "created_at": "2023-03-14T13:46:27-06:00",
    "updated_at": "2023-03-14T13:46:27-06:00",
    "name": "string",
    "phone": "string",
    "street_address": "string",
    "street_address_line_2": "string",
    "city": "string",
    "region": "string",
    "postal_code": "string",
    "country": "string",
    "website": "string",
    "notes": "string",
    "fuel": true,
    "service": true,
    "parts": true,
    "vehicle": true,
    "contact_name": "string",
    "contact_email": "string",
    "contact_phone": "string",
    "latitude": 0,
    "longitude": 0,
    "external_id": "string",
    "archived_at": "string",
    "labels": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "custom_fields": {}
  }
]

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/vendors' \
-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!