Skip to main content

List Vendors

Returns a list of Vendors belonging to your account.

Query Parameters
  • start_cursor string

    The start cursor for Keyset pagination.

  • per_page integer

    Possible values: >= 2 and <= 100

    Default value: 50

    The number of records per page to return.

  • filter object

    The fields, operations, and values to filter the records by.

    • name object
      oneOf
    • like string required
    • external_id object
    • eq string required
    • created_at object
      oneOf
    • lt string required
    • updated_at object
      oneOf
    • lt string required
  • sort object

    The fields and direction to sort the results by.

    • id string

      Possible values: [asc, desc]

      Default value: desc

    • created_at string

      Possible values: [asc, desc]

    • updated_at string

      Possible values: [asc, desc]

Responses

OK

Schema

  • start_cursor string

    The current start cursor of the records returned.

  • next_cursor string

    The next cursor to retrieve the next page of records.

  • per_page integer

    The maxumum number of records returned.

  • estimated_remaining_count integer

    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.

    anyOf
  • name object
    oneOf
  • like string
  • sorted_by object[]

    The sorts applied to the returned record set.

    anyOf
  • created_at string

    Possible values: [asc, desc]

  • records object[]
  • id integer
  • created_at date-time
  • updated_at date-time
  • 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.

  • custom_fields object

    *Full details on working with Custom Fields here.

  • labels object[]
  • id integer

    Possible values: >= 1

  • name string
Loading...