Get Subcontractors By Filter

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. Rule-engine-based list endpoint — an alternative to the simple filter.* query params on the plain List endpoint, for building complex AND/OR filter conditions.

post/subcontractors/filter

Request

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

Request body

pagestring
limitstring

Max 1000 — larger values are rejected with 400.

sort'ASC' | 'DESC'
sort_bystring
filter_rulesobject[]
filter_rule_operator'AND' | 'OR'

Response

200

type'SUCCESS'
messagestring
dataobject[]
total_recordsinteger
current_pageinteger
total_pagesinteger

Changes