Available Tools
| Tool | Endpoint | Description |
|---|---|---|
get_companies | GET /api/v1/companies | List of companies |
get_company_buildings | GET /api/v1/companies/{id}/buildings | Buildings for a company |
get_company_departments | GET /api/v1/companies/{id}/departments | Departments |
get_company_year_configuration | GET /api/v1/companies/{id}/year-configuration | Active year configuration |
Usage Examples
"List all my companies"
→ get_companies()
"What buildings does company ABC have?"
→ get_company_buildings({ id: "company-uuid" })
"What departments does my main company have?"
→ get_company_departments({ id: "company-uuid" })
"What is the annual configuration of my company?"
→ get_company_year_configuration({ id: "company-uuid" })
Common Parameters
get_companies
| Parameter | Type | Description |
|---|---|---|
page | integer | Page number |
limit | integer | Results per page (max 200 recommended; use pagination for larger datasets) |
companyIds | string[] | Filter by company IDs |
get_company_buildings
| Parameter | Type | Description |
|---|---|---|
id | string | Company ID (required) |
page | integer | Page number |
limit | integer | Results per page (max 200 recommended; use pagination for larger datasets) |
Typical Response
{
"data": [
{
"id": "1b1e07a7-083d-4831-a1d2-84b6e93a1572",
"name": "My Company Inc.",
"country": "US"
}
],
"pagination": {
"page": 1,
"limit": 25,
"total": 3
}
}