getCompanies
Retrieve a filtered list of companies using parameters like search terms, tags, custom fields, and pagination. Includes options for full profiles and company stats.
Instructions
Get a list of companies, retrieve all companies for the provided filters. This endpoint allows you to filter companies by various parameters including custom fields, tags, search terms, and more.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fullProfile | No | Include full profile information | |
| getStats | No | Include stats of company tasks and projects | |
| includeCustomFields | No | Include custom fields in the response | |
| orderBy | No | Field to order results by (e.g., name, dateadded, etc.) | |
| orderMode | No | Sort order (asc or desc) | |
| page | No | Page number for pagination | |
| pageSize | No | Number of items per page | |
| searchTerm | No | Filter by company name and description | |
| tagIds | No | Filter by tag IDs |