Contractors.es icon

Contractors.es

Interact with Contractors.es API

Actions995

Subcontractors Agreement Api → Post Api Contractors Subcontractors Agreements Search

AI-generated

Summary

Searches the Contractors.es subcontractor agreements API, optionally including deleted agreements or returning only deleted agreements. Supports pagination and JSON request-body criteria for scopes, filters, search terms, and sorting.

Inputs

  • With Trashed — Query parameter; defaults to false. Set true to include trashed agreements.
  • Only Trashed — Query parameter; defaults to false. Set true to return only trashed agreements.
  • Page — Query parameter for the page to request; defaults to 1.
  • Limit — Query parameter for the number of results per page; defaults to 20.
  • Scopes — Optional JSON value sent in the request body as scopes. Leave at its default sentinel to omit it.
  • Filters — Optional JSON value sent in the request body as filters. Leave at its default sentinel to omit it.
  • Search — Optional JSON value sent in the request body as search. Leave at its default sentinel to omit it.
  • Sort — Optional JSON value sent in the request body as sort. Leave at its default sentinel to omit it.
  • Request Options — Optional HTTP request settings: batching and interval, proxy, timeout, or acceptance of invalid SSL certificates.

Output shape

A list of matching subcontractor agreement records, returned by the API.

The operation uses the configured Contractors.es API URL and required Contractors.es API credentials. Pagination is controlled by Page and Limit; the exact response envelope and record fields are not specified in the provided source.

Links

Discussion