Skip to main content

List Vendors

Returns a list of Vendors belonging to your account.

Responses

OK

Response Headers

  • X-PaginationLimit string

    The per page limit. Currently set to 100 but subject to change at any time.

  • X-Pagination-Current-Page string

    The current page. Defaults to 1.

  • X-Pagination-Total-Pages string

    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 string

    The total number of records in the result set (across all pages).

Schema

array
  • id integer

    Possible values: >= 1

  • created_at date-time

    The date and time at which this record was created.

  • updated_at date-time

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

  • name string

    The name of the Vendor.

  • phone string

    The phone number of the Vendor.

  • street_address string

    The street address of the Vendor.

  • street_address_line_2 string

    The second line of the street address of the Vendor.

  • city string

    The city of the Vendor.

  • region string

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

  • postal_code string

    The postal code or ZIP code of the Vendor.

  • country string

    The country of the Vendor.

  • website string

    The website of the Vendor.

  • notes string

    Additional notes about the Vendor.

  • fuel boolean

    Indicates whether the Vendor provides fuel.

  • service boolean

    Indicates whether the Vendor provides service.

  • parts boolean

    Indicates whether the Vendor provides parts.

  • vehicle boolean

    Indicates whether the Vendor provides vehicles.

  • contact_name string

    The name of the contact person for the Vendor.

  • contact_email string

    The email address of the contact person for the Vendor.

  • contact_phone string

    The phone number of the contact person for the Vendor.

  • latitude float

    The latitude of the Vendor's location.

  • longitude float

    The longitude of the Vendor's location.

  • external_id string

    The external identifier of the Vendor.

  • archived_at string

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

  • labels object[]
  • id integer

    Possible values: >= 1

  • name string
  • custom_fields object

    *Full details on working with Custom Fields here.

Loading...