Skip to main content

​
Available Tools

ToolEndpointDescription
get_companiesGET /api/v1/companiesList of companies
get_company_buildingsGET /api/v1/companies/{id}/buildingsBuildings for a company
get_company_departmentsGET /api/v1/companies/{id}/departmentsDepartments
get_company_year_configurationGET /api/v1/companies/{id}/year-configurationActive 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

ParameterTypeDescription
pageintegerPage number
limitintegerResults per page (max 1000)
companyIdsstring[]Filter by company IDs

​
get_company_buildings

ParameterTypeDescription
idstringCompany ID (required)
pageintegerPage number
limitintegerResults per page

​
Typical Response

{
  "data": [
    {
      "id": "1b1e07a7-083d-4831-a1d2-84b6e93a1572",
      "name": "My Company Inc.",
      "country": "US"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 25,
    "total": 3
  }
}