Skip to main content

Retrieve Vendor

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

Retrieve the details of an existing Vendor.

Request​

Path Parameters

    id stringrequired

    Possible values: Value must match regular expression ^[0-9]+$

    The id of the relevant record

Responses​

OK

Schema
    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.

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 -L 'https://secure.fleetio.com/api/v1/vendors/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Token <Authorization>' \
-H 'Account-Token: <Authorization>'
Request Collapse all
Base URL
https://secure.fleetio.com/api
Auth
Parameters
— pathrequired
ResponseClear

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