Vendors

Retrieve Vendor

Retrieve the details of an existing Vendor.

get/vendors/{id}

Request

Path parameters

idstring required

The id of the relevant record

Response

OK

idinteger required
created_atstring date-time

The date and time at which this record was created.

updated_atstring date-time

The date and time at which this record was most recently updated.

namestring required

The name of the Vendor.

phonestring nullable required

The phone number of the Vendor.

street_addressstring nullable required

The street address of the Vendor.

street_address_line_2string nullable required

The second line of the street address of the Vendor.

citystring nullable required

The city of the Vendor.

regionstring nullable required

The region, state, province, or territory of the Vendor.

postal_codestring nullable required

The postal code or ZIP code of the Vendor.

countrystring nullable required

The country of the Vendor.

websitestring nullable required

The website of the Vendor.

notesstring nullable required

Additional notes about the Vendor.

fuelboolean nullable required

Indicates whether the Vendor provides fuel.

serviceboolean nullable required

Indicates whether the Vendor provides service.

partsboolean nullable required

Indicates whether the Vendor provides parts.

vehicleboolean nullable required

Indicates whether the Vendor provides vehicles.

contact_namestring nullable required

The name of the contact person for the Vendor.

contact_emailstring nullable required

The email address of the contact person for the Vendor.

contact_phonestring nullable required

The phone number of the contact person for the Vendor.

latitudenumber float nullable required

The latitude of the Vendor's location.

longitudenumber float nullable required

The longitude of the Vendor's location.

external_idstring nullable required

The external identifier of the Vendor.

archived_atstring nullable required

The date and time when the Vendor was archived, if applicable.

custom_fieldsCustomFields nullable required

*Full details on working with Custom Fields here.

Example response

{
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00"
}

Changes

No recorded changes to this operation across all 1 revision of this API.