Contractors.es icon

Contractors.es

Interact with Contractors.es API

Actions995

Company Group Api → Post Api Crm Company Groups Search

AI-generated

Summary

Search for company groups in the Contractors.es CRM using API filters, pagination, and soft-delete options.

Inputs

  • Filters — A JSON object defining search criteria (e.g., name, status) to filter company groups. Defaults to DO_NOT_SET if empty.
  • Limit — The maximum number of groups to return per page. Defaults to 20.
  • Page — The page number for paginated results. Defaults to 1.
  • Sort — A JSON object defining sort order (e.g., {name: 'asc'}). Defaults to DO_NOT_SET if empty.
  • With Trashed — Include soft-deleted (trashed) groups in the results. Defaults to false.
  • Only Trashed — Return only soft-deleted groups. Defaults to false.
  • Request Options — Advanced HTTP settings such as batching, timeouts, proxy, and SSL validation.

Output shape

A list of items, each representing a company group with its data.

Supports pagination via the Page and Limit parameters. Soft-deleted groups can be included or filtered using the trashed options.

Examples

Example 1: Find active company groups with a specific name pattern

Filters set to {name: {operator: 'like', value: 'Construction'}}, Limit set to 50, With Trashed set to false.

Example 2: Retrieve the first 10 soft-deleted groups

Only Trashed set to true, Page set to 1, Limit set to 10.

Links

Discussion