Contractors.es icon

Contractors.es

Interact with Contractors.es API

Actions995

Company Group Api → Get Api Crm Company Groups Company Group

AI-generated

Summary

Retrieve details of a specific Company Group from the Contractors.es CRM API by its numeric ID, optionally including trashed (deleted) groups.

Inputs

  • Company Group (required) — The unique numeric ID of the company group to retrieve.
  • With Trashed — Boolean flag indicating whether to include trashed (soft-deleted) company groups in the results.
  • Only Trashed — Boolean flag indicating whether to retrieve only trashed (soft-deleted) company groups.

Output shape

a single JSON object representing the company group details

The returned data corresponds to the specified company group ID. Query parameters 'with_trashed' and 'only_trashed' can modify which records are considered. The output contains structured JSON data as returned by the Contractors.es API.

Examples

Example 1: Retrieve a company group with ID 123 excluding trashed groups.

Set 'Company Group' to 123, 'With Trashed' and 'Only Trashed' left as false.

Example 2: Retrieve a company group including trashed entries.

Set 'Company Group' to the desired ID, 'With Trashed' to true, and 'Only Trashed' to false.

Links

Discussion