Contractors.es icon

Contractors.es

Interact with Contractors.es API

Actions995

Company Api → Post Api Crm Companies Search

AI-generated

Summary

Search CRM companies using complex query parameters supporting filters, sorting, pagination, and trashed record inclusion options.

Inputs

  • With Trashed — Boolean to include soft-deleted companies in the results.
  • Only Trashed — Boolean to restrict results to only soft-deleted companies.
  • Page — Page number for paginated results, defaulting to 1.
  • Limit — Maximum number of results per page, defaulting to 20.
  • Scopes — JSON object specifying scopes or fields to retrieve, optional.
  • Filters — JSON object defining complex filtering criteria for the search.
  • Sort — JSON object defining sorting rules for the returned companies.

Output shape

a JSON list of company records matching the search criteria

Pagination is controlled via the 'page' and 'limit' query parameters; soft-deleted (trashed) companies can be included or exclusively selected using 'With Trashed' and 'Only Trashed' flags respectively. Filters, scopes, and sort are sent as JSON in the request body and are optional. Returned data shape depends on the API response.

Examples

Example 1: Search companies including trashed, filtered and sorted

Set 'With Trashed' to true, specify JSON in 'Filters' and 'Sort' to filter and order results respectively, adjust 'Page' and 'Limit' for pagination.

Links

Discussion