ZUzuper

Get Vendors

Changed on

Operates on Vendors. In the Zuper client app this module is labeled "Vendor" for most companies, and "Supplier" for companies in the roofing industry — the API and data shape are identical either way. Vendors and Subcontractors share the exact same underlying schema and endpoints; they're distinguished only by the vendor_type field (VENDOR here) and the /vendors vs /subcontractors route prefix. vendor_type is always enforced server-side based on this route; you cannot use this endpoint to read the other module's records.

get/vendors

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/vendors
  • Auth
    API key in header x-api-key

Query parameters

pageinteger
countstring
sort'ASC' | 'DESC'
sort_bystring
filter.is_activeboolean
filter.keywordstring
filter.created_bystring
filter.is_deletedboolean
filter.from_catalog_countinteger
filter.to_catalog_countinteger
filter.from_lead_timeinteger
filter.to_lead_timeinteger
filter.last_ordered_from_datestring date
filter.last_ordered_to_datestring date
filter.created_from_datestring date

eg: 2025-05-12

filter.created_to_datestring date

eg: 2025-05-12

filter.updated_from_datestring date
filter.updated_to_datestring date
filter.vendor_delivery_methodstring
filter.custom_fieldstring
filter.supplier_provider_uidstring
filter.integrated_vendorsboolean
filter.favorite_supplier_vendorboolean

Response

200

type'SUCCESS'
messagestring
dataobject[]

Deselects _id, company_id, __v, accounts, vendor_bank_details, vendor_contacts, attachments, and internal supplier-integration IDs.

total_recordsinteger
current_pageinteger
total_pagesinteger

Changes

  • 3c21bc232e16Revision changes
    • breaking

      the query request parameter sort was restricted to a list of enum values

    • breaking

      for the query request parameter page, default value was changed from 1 to 1

    • breaking

      for the query request parameter filter.created_from_date, the format changed from no format to date

    • breaking

      for the query request parameter filter.created_to_date, the format changed from no format to date

    • breaking

      for the query request parameter filter.from_catalog_count, the type changed from string to integer

    • breaking

      for the query request parameter filter.from_lead_time, the type changed from string to integer

    • breaking

      for the query request parameter filter.last_ordered_from_date, the format changed from no format to date

    • breaking

      for the query request parameter filter.last_ordered_to_date, the format changed from no format to date

    • breaking

      for the query request parameter filter.to_catalog_count, the type changed from string to integer

    • breaking

      for the query request parameter filter.to_lead_time, the type changed from string to integer

    • warning

      deleted the query request parameter filter.updated_at_from

    • warning

      deleted the query request parameter filter.updated_at_to

    • info

      added the new optional query request parameter count

    • info

      added the new optional query request parameter filter.created_by

    • info

      added the new optional query request parameter filter.custom_field

    • info

      added the new optional query request parameter filter.favorite_supplier_vendor

    • info

      added the new optional query request parameter filter.integrated_vendors

    • info

      added the new optional query request parameter filter.is_deleted

    • info

      added the new optional query request parameter filter.supplier_provider_uid

    • info

      added the new optional query request parameter filter.updated_from_date

    • info

      added the new optional query request parameter filter.updated_to_date

    • info

      added the new optional query request parameter sort_by

    • info

      added the new enum value ASC to the query request parameter sort

    • info

      added the new enum value DESC to the query request parameter sort

    • info

      added the media type application/json for the response with the status