List Vendors

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

Returns a list of Vendors belonging to your account.

Request

Query Parameters

start_cursor string

The start cursor for Keyset pagination.

per_page integer
Possible values: >= 2 and <= 100
The number of records per page to return.
Default value: 50
filter object
The fields, operations, and values to filter the records by.
name object
oneOf
LikeFilter
likestringrequired
EqFilter
eqstringrequired
external_id object
eqstringrequired
created_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
updated_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
sort object

The fields and direction to sort the results by.

idSortAscDescDefaultDesc (string)

Possible values: [asc, desc]

Default value: desc

created_atSortAscDesc (string)

Possible values: [asc, desc]

updated_atSortAscDesc (string)

Possible values: [asc, desc]

Responses

200

OK

application/json

Schema

Schema

start_cursorstringnullable
The current start cursor of the records returned.
next_cursorstringnullable
The next cursor to retrieve the next page of records.
per_pageinteger
The maxumum number of records returned.
estimated_remaining_countinteger
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.
Array [
anyOf
MOD1
name object
oneOf
LikeFilter
likestringrequired
EqFilter
eqstringrequired
MOD2
external_id object
eqstringrequired
MOD3
created_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
MOD4
updated_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
]
sorted_by object[]
The sorts applied to the returned record set.
Array [
anyOf
MOD1
created_atSortAscDesc (string)
Possible values: [asc, desc]
MOD2
updated_atSortAscDesc (string)
Possible values: [asc, desc]
MOD3
idSortAscDesc (string)
Possible values: [asc, desc]
]
records object[]
Array [
idintegerrequired
created_atdate-timerequired
updated_atdate-timerequired
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.
custom_fieldsobjectnullable
*Full details on working with Custom Fields here.
labels object[]required
Array [
idId (integer)
Possible values: >= 1
namestring
]
]

Example (auto)

{
  "start_cursor": "string",
  "next_cursor": "string",
  "per_page": 0,
  "estimated_remaining_count": 0,
  "filtered_by": [
    {
      "name": {
        "like": "string"
      }
    },
    {
      "external_id": {
        "eq": "string"
      }
    },
    {
      "created_at": {
        "lt": "string"
      }
    },
    {
      "updated_at": {
        "lt": "string"
      }
    }
  ],
  "sorted_by": [
    {
      "created_at": "asc"
    },
    {
      "updated_at": "asc"
    },
    {
      "id": "asc"
    }
  ],
  "records": [
    {
      "id": 0,
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z",
      "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",
      "custom_fields": {},
      "labels": [
        {
          "id": 0,
          "name": "string"
        }
      ]
    }
  ]
}

400

The format or parameters of the request was invalid

application/json

Schema

Schema

errors object
property name* string[]
Array [
string
]

Example (auto)

{
  "errors": {}
}

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: <Authorization>' \
-H 'Account-Token: <Authorization>'

Request Collapse all

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Parameters

start_cursor — query

per_page — query

filter — query

namelikeeq

external_ideq

created_atltltegtgte

updated_atltltegtgte

sort — query

id---ascdesc

created_at---ascdesc

updated_at---ascdesc

ResponseClear

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