getCompanies
Find and filter companies by name, tags, custom fields, or search terms using this Teamwork MCP tool. Retrieve detailed profiles, stats, and paginated results for efficient company management.
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 |
Input Schema (JSON Schema)
{
"properties": {
"fullProfile": {
"description": "Include full profile information",
"type": "boolean"
},
"getStats": {
"description": "Include stats of company tasks and projects",
"type": "boolean"
},
"includeCustomFields": {
"description": "Include custom fields in the response",
"type": "boolean"
},
"orderBy": {
"description": "Field to order results by (e.g., name, dateadded, etc.)",
"type": "string"
},
"orderMode": {
"description": "Sort order (asc or desc)",
"enum": [
"asc",
"desc"
],
"type": "string"
},
"page": {
"description": "Page number for pagination",
"type": "integer"
},
"pageSize": {
"description": "Number of items per page",
"type": "integer"
},
"searchTerm": {
"description": "Filter by company name and description",
"type": "string"
},
"tagIds": {
"description": "Filter by tag IDs",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}