Get Subcontractors

Changed on

Operates on Subcontractors, shown in the Zuper client app as "Subcontractor" (in every industry). Subcontractors share the exact same underlying schema and endpoints as Vendors / Suppliers; they're distinguished only by the vendor_type field (SUB_CONTRACTOR here) and the /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/subcontractors

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/subcontractors
  • 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