Vendors

List vendors

Retrieve a paginated list of vendors with filtering, search, and ordering capabilities.

get/public/v1/vendors/

Query parameters

searchstring nullable
codestring[] nullable
idinteger[] nullable
vendor_typestring[] nullable
namestring nullable
unique_idstring nullable
emailstring nullable
websitestring nullable
single_addressstring nullable
countrySystemCountries[] nullable
statestring nullable
phonestring nullable
is_activeboolean nullable
is_1099_eligibleboolean nullable
tinstring nullable
record_statusRecordStatus[] nullable
company_idinteger[] nullable
exclude_company_idinteger[] nullable
namesstring[] nullable
start_datestring date nullable
end_datestring date nullable
approval_statusstring[] nullable
approval_status_scopeRecordStatus[] nullable
view'compact'
company_id_accessinteger[] nullable
updated_afterstring date-time nullable
updated_beforestring date-time nullable
orderingstring nullable
limitinteger

Number of records to return per page (capped at 100)

Number of records to return per page (capped at 100)

offsetinteger

Number of records to skip before starting to return results

Number of records to skip before starting to return results

Response

OK

countinteger required

Changes

Changed in 6 of the 27 revisions of this API.11

    • ○

      for the query request parameter country, the type was generalized from string null to array null

      request-parameter-type-generalized

    • ○

      added the new optional query request parameter code

      new-optional-request-parameter

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the new optional query request parameter updated_after

      new-optional-request-parameter

    • ○

      added the new optional query request parameter updated_before

      new-optional-request-parameter

    • ○

      added the required property // to the response with the status

      response-required-property-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      added the new optional query request parameter company_id_access

      new-optional-request-parameter

    • ○

      added the new optional query request parameter approval_status_scope

      new-optional-request-parameter

    • ○

      added the new optional query request parameter view

      new-optional-request-parameter

Of the 27 revisions, 1 has no diff computed.