API Portal
Создавайте интеграции с REST-методами, API-ключами и вебхуками.
Посмотреть методы — API PortalСоздавайте интеграции ConnectMe по руководствам API: аутентификация, сотрудники, CRM, объекты, оборудование, заказ-наряды, проверки и отчёты.
Base URL
https://demo.connectme.work/v1/apiСоздавайте интеграции с REST-методами, API-ключами и вебхуками.
Посмотреть методы — API PortalПредоставляйте ИИ-помощникам инструменты чтения с личным согласием и проверкой текущих прав доступа.
Посмотреть методы — MCP GatewayIn ConnectMe, open Setup → API Portal → Management and create a client for one integration.
Select only the read and write scopes required for that integration.
The cm_live_ key is a secret. Keep it server-side and never embed it in browser or mobile code.
Send the key as a Bearer token or X-API-Key header to the organization-scoped endpoint.
curl --request GET \
--url 'https://demo.connectme.work/v1/api/employees?skip=0&take=25&sort=ASC&orderBy=&filter=' \
--header 'Authorization: Bearer cm_live_YOUR_API_KEY' \
--header 'Accept: application/json'const response = await fetch(
'https://demo.connectme.work/v1/api/work-orders?skip=0&take=25&sort=ASC&orderBy=&filter=&dateFrom=2026-10-01&dateTo=2026-10-31',
{
headers: {
Authorization: 'Bearer cm_live_YOUR_API_KEY',
Accept: 'application/json',
},
},
);
if (!response.ok) throw new Error(`ConnectMe API: ${response.status}`);
const workOrders = await response.json();Every protected request requires an active API key attached to an active API client. Keys may expire or be revoked, and clients can optionally restrict allowed source IP addresses.
Authorization: Bearer cm_live_...X-API-Key: cm_live_...Most domains provide separate :read and :write scopes. A request returns 403 when its API client does not contain every required scope.
These groups summarize implemented external routes. Use the interactive reference for complete request and response schemas.
Local source snapshot 2026-11-08: 144 business methods, API v1.3.0. Paths are relative to /v1/api. Technical reference text is in English; identifiers are unchanged in every language.
Download local OpenAPI with parameters, bodies and response schemas144 of 144 methods
/mcp/staff/inspections/{actId}mcpGetStaffInspectioninspections:readDelegated MCP only · API keys rejected/mcp/resident/propertiesmcpListResidentPropertiesresident:properties:readDelegated MCP only · API keys rejected/mcp/resident/properties/{siteId}/requestsmcpListResidentRequestsresident:requests:readDelegated MCP only · API keys rejected/mcp/resident/properties/{siteId}/requests/{id}mcpGetResidentRequestresident:requests:readDelegated MCP only · API keys rejected/mcp/supplier/bidsmcpListSupplierOpportunitiessupplier:bids:readDelegated MCP only · API keys rejected/mcp/supplier/bids/{bidRequestId}/statusmcpGetOwnSupplierBidStatussupplier:bids:readDelegated MCP only · API keys rejected/mcp/staff/inspectionsList currently authorized staff inspectionsinspections:readDelegated MCP only · API keys rejectedinspections:readresident:properties:readresident:requests:readsupplier:bids:read/building-finance/importsList normalized financial importsbuilding-finance:read/building-finance/importsStage a normalized building-finance documentbuilding-finance:write/building-finance/imports/{id}/documentUpload invoice PDF bytesbuilding-finance:write/building-finance/paymentsImport payment allocationsbuilding-finance:write/building-finance/provider-identitiesList provider identity mappingsbuilding-finance:read/building-finance/provider-identitiesBind a provider identitybuilding-finance:write/building-management/buildings/{buildingPartyId}/apartments/{siteId}/financial-documentsList canonical apartment billsbuilding-finance:read/building-management/buildings/{buildingPartyId}/apartments/{siteId}/paymentsList canonical apartment paymentsbuilding-finance:read/building-management/financial-documents/{id}/detailsGet canonical bill detailsbuilding-finance:readbuilding-finance:readbuilding-finance:write/employeesList employeesemployees:read/employeesCreate employee and invitation useremployees:write/employees/{employeeId}Get employeeemployees:read/employees/{employeeId}Update employeeemployees:write/employees/{employeeId}/discontinueEnd-date employee and user loginemployees:writeemployees:reademployees:write/time/worked-shiftsGet worked shifts and reported entriestime:read/time/summaryGet worked-time and pay summary by employeetime:readtime:read/expensesList expense headers and linesexpenses:readexpenses:read/absencesList vacations and absencesabsences:read/absencesCreate vacation or absenceabsences:write/absences/{absenceId}Get absenceabsences:read/absences/{absenceId}Update absenceabsences:write/absences/{absenceId}Delete absenceabsences:writeabsences:readabsences:write/clientsList CRM clientsclients:read/clientsCreate CRM clientclients:write/clients/{clientId}Get CRM client detailsclients:read/clients/{clientId}Update CRM clientclients:write/clients/{clientId}/sitesList sites for CRM clientsites:read/clients/{clientId}/sitesCreate site for CRM clientsites:write/clients/{clientId}/sites/{siteId}Update site for CRM clientsites:writeclients:readclients:writesites:readsites:write/clients/{clientId}/contactsList contacts for CRM clientcontacts:read/clients/{clientId}/contactsCreate contact for CRM clientcontacts:write/contactsList CRM contactscontacts:read/contacts/{contactPointId}Update CRM contactcontacts:writecontacts:readcontacts:write/locationsList CRM site locationslocations:readlocations:read/sitesList organization sitessites:read/sitesCreate organization site with locationsites:write/sites/{siteId}Get organization sitesites:read/sites/{siteId}Update organization sitesites:writesites:readsites:write/sites/{siteId}/equipmentList equipmentsetup:read/sites/{siteId}/equipmentCreate equipmentsetup:write/sites/{siteId}/equipment/{equipmentId}Get equipmentsetup:read/sites/{siteId}/equipment/{equipmentId}Update equipmentsetup:write/sites/{siteId}/equipment/{equipmentId}Delete equipmentsetup:writesetup:readsetup:write/compensationsList compensation definitionscompensation:read/compensationsCreate compensation definitioncompensation:write/employees/{employeeId}/compensationsAssign compensation to employeecompensation:writecompensation:readcompensation:write/materialsList materialsmaterials:read/materialsCreate materialmaterials:write/materials/{materialId}Get materialmaterials:read/materials/{materialId}Update materialmaterials:writematerials:readmaterials:write/suppliersList supplierssuppliers:read/suppliersCreate suppliersuppliers:write/suppliers/{supplierPartyId}Get supplier detailssuppliers:read/suppliers/{supplierPartyId}/employeesList supplier employeessuppliers:read/suppliers/{supplierPartyId}/employeesCreate supplier employeesuppliers:write/suppliers/{supplierPartyId}/employees/{employeePartyId}Update supplier employeesuppliers:writesuppliers:readsuppliers:write/suppliers/{supplierPartyId}/agreementsList agreements for supplieragreements:read/agreementsList agreementsagreements:read/agreementsCreate agreementagreements:write/agreements/statsGet agreement expiry statisticsagreements:read/agreements/{agreementId}Get agreementagreements:read/agreements/{agreementId}Update agreementagreements:write/agreements/{agreementId}Terminate agreementagreements:writeagreements:readagreements:write/work-ordersList CRM work orderswork-orders:read/work-ordersCreate CRM work orderwork-orders:write/work-orders/{workOrderId}Get CRM work orderwork-orders:read/work-orders/{workOrderId}Update CRM work orderwork-orders:write/clients/{clientId}/work-ordersList CRM client work orderswork-orders:read/sites/{siteId}/work-ordersList CRM site work orderswork-orders:readwork-orders:readwork-orders:write/work-orders/{workOrderId}/statisticsGet work order statisticswork-order-reports:read/clients/{clientId}/work-orders/statisticsGet client work order statisticswork-order-reports:read/sites/{siteId}/work-orders/statisticsGet site work order statisticswork-order-reports:read/clients/{clientId}/sites/{siteId}/work-orders/statisticsGet client-site work order statisticswork-order-reports:read/work-orders/{workOrderId}/report/pdfDownload work order PDF reportwork-order-reports:read/work-orders/{workOrderId}/report/excelDownload work order Excel reportwork-order-reports:read/work-orders/{workOrderId}/report/csvDownload work order CSV reportwork-order-reports:read/clients/{clientId}/work-orders/statistics/report/pdfDownload client work order statistics PDF reportwork-order-reports:readwork-order-reports:read/building-management/buildings/{buildingPartyId}/apartments/{siteId}/meter-readingsList apartment meter readingsbuilding-management:read/building-management/buildings/{buildingPartyId}/apartments/{siteId}/meter-readingsCreate apartment meter readingbuilding-management:write/building-management/buildings/{buildingPartyId}/apartments/{siteId}/metersList configured apartment metersbuilding-management:read/building-management/buildings/{buildingPartyId}/apartments/{siteId}/metersCreate an apartment meterbuilding-management:write/building-management/buildings/{buildingPartyId}/apartments/{siteId}/meters/{meterId}Update an apartment meterbuilding-management:write/building-management/buildings/{buildingPartyId}/apartments/{siteId}/meter-readings/{id}/correctionsCorrect an apartment meter readingbuilding-management:write/building-management/buildings/{buildingPartyId}/metersList communal building metersbuilding-management:read/building-management/buildings/{buildingPartyId}/metersCreate communal building meterbuilding-management:write/building-management/buildings/{buildingPartyId}/meters/{meterId}Update communal building meterbuilding-management:write/building-management/buildings/{buildingPartyId}/meter-readingsList communal building meter readingsbuilding-management:read/building-management/buildings/{buildingPartyId}/meter-readingsCreate communal building meter readingbuilding-management:write/building-management/buildings/{clientId}/apartments/{siteId}/personsList apartment owners, tenants, payers, and contactsbuilding-management:read/building-management/buildings/{clientId}/apartments/{siteId}/personsCreate apartment person relationshipbuilding-management:write/building-management/buildings/{clientId}/apartments/{siteId}/persons/{relationshipId}Update apartment person relationshipbuilding-management:write/building-management/buildings/{clientId}/apartments/{siteId}/persons/{relationshipId}End apartment person relationshipbuilding-management:write/building-management/buildings/{buildingPartyId}/house-seniorsList house senior assignments for buildingbuilding-management:read/building-management/buildings/{buildingPartyId}/house-seniorsAssign house senior to buildingbuilding-management:write/building-management/buildings/{buildingPartyId}/house-seniors/{relationshipId}Update house senior assignmentbuilding-management:write/building-management/buildings/{buildingPartyId}/house-seniors/{relationshipId}End house senior assignmentbuilding-management:write/building-management/meter-readings/{id}Update meter readingbuilding-management:write/building-management/meter-readings/{id}Delete meter readingbuilding-management:write/building-management/buildings/{buildingPartyId}/financial-documentsList building financial documentsbuilding-management:read/building-management/buildings/{buildingPartyId}/financial-documentsCreate building financial documentbuilding-management:write/building-management/financial-documents/{id}Update financial documentbuilding-management:write/building-management/financial-documents/{id}Delete financial documentbuilding-management:write/building-management/buildings/{buildingPartyId}/paymentsList building paymentsbuilding-management:read/building-management/buildings/{buildingPartyId}/paymentsCreate building paymentbuilding-management:write/building-management/payments/{id}Update paymentbuilding-management:write/building-management/payments/{id}Delete paymentbuilding-management:write/building-management/buildings/{buildingPartyId}/tasksList building CRM tasksbuilding-management:read/building-management/buildings/{buildingPartyId}/tasksCreate building CRM taskbuilding-management:write/building-management/tasks/{id}Update building CRM taskbuilding-management:write/building-management/notificationsList building notificationsbuilding-management:read/building-management/notificationsCreate or queue building notificationbuilding-management:write/building-management/notifications/{id}Update or send draft building notificationbuilding-management:write/building-management/notifications/{id}Delete draft building notificationbuilding-management:write/building-management/sync-attemptsList building-management sync attemptsbuilding-management:sync/building-management/sync/{objectType}/{id}Synchronize one building-management objectbuilding-management:syncbuilding-management:readbuilding-management:writebuilding-management:sync/building-management/buildings/{buildingPartyId}/apartments/{siteId}/agreementsList apartment ownership and tenancy agreementsbuilding-ownership:read/building-management/buildings/{buildingPartyId}/apartments/{siteId}/agreementsCreate an apartment ownership or tenancy agreementbuilding-ownership:write/building-management/apartment-agreements/{agreementId}Update an apartment agreementbuilding-ownership:writebuilding-ownership:readbuilding-ownership:write/inspections/buildingsList inspection buildingsinspections:read/inspections/buildings/{clientId}/historyList building inspection historyinspections:read/inspections/buildings/{clientId}/work-ordersList inspection work orders for buildinginspections:read/inspections/work-orders/{workOrderId}/detailsGet section-scoped inspection details for a work orderinspections:read/inspections/act-templatesList inspection act templatesinspections:read/inspections/actsList inspection actsinspections:read/inspections/actsCreate inspection actinspections:write/inspections/acts/{actId}Get inspection act detailsinspections:read/inspections/acts/{actId}Update inspection actinspections:write/inspections/acts/{actId}/valuesReplace inspection act valuesinspections:write/inspections/acts/{actId}/evidenceAdd inspection evidence metadatainspections:write/inspections/acts/{actId}/defectsList inspection defectsinspections:read/inspections/acts/{actId}/defectsCreate inspection defectinspections:write/inspections/acts/{actId}/work-ordersList work orders linked to inspection actinspections:read/inspections/acts/{actId}/work-ordersCreate work order from inspection actinspections:write, work-orders:write/inspections/acts/{actId}/section-work-ordersCreate section work orders for one inspection actinspections:write, work-orders:write/inspections/acts/{actId}/statisticsGet inspection act rollup statisticsinspections:read/inspections/acts/{actId}/versionsList inspection act versionsinspections:readinspections:readinspections:writework-orders:write/attachmentsList attachment metadataattachments:readattachments:readMCP Gateway · v0.3.0 · Streamable HTTP
Ten implemented tools cover staff operations, resident properties and requests, and supplier opportunities. OAuth authorization code with PKCE S256 binds each grant to personal consent, one audience and the selected organization. Current permissions are checked again on execution. API keys cannot replace delegated consent.
Local verification snapshot: 2026-11-08. MCP is disabled by default. HTTPS client interoperability, deployment and production acceptance remain open. Obtain the gateway URL and approved client registration from your administrator.
Missing or partial tools include planned schedules, availability, conflicts, overdue work orders, operational history, property defects and unified maintenance history. Worked-time reads need a compensation-safe contract. The downloadable gap report records each dependency.
Use the configured gateway origin with /mcp. Discover OAuth through /.well-known/oauth-protected-resource/mcp. Use a pre-registered client and exact callback URI.
Initialize an MCP client, then use tools/list and tools/call. Discovery only returns tools allowed by your grant. Operational write tools are unavailable.
take: 1–50 (default 20). skip is a row offset; page is zero-based. IDs are positive decimal strings. Unknown arguments are rejected. Full input/output schemas are in the catalogue below.
10 of 10 tools
STAFF · inspections:read
Read core staff inspection details by act ID within current organization, agent and inspection assignment permissions. Requires inspections:read and enabled inspections. Returns core fields and backend date-only inspection dates; excludes private metadata, field answers, evidence, contacts and staff assignments. Resident publications are separate.
GET /v1/api/mcp/staff/inspections/:actIdAccess: Current inspection role and assignment scope; enabled inspections; exact resource
{
"name": "get_property_inspection_details",
"arguments": {
"act_id": "70"
}
}RESIDENT · resident:properties:read
List only properties currently accessible to the consenting resident in the current organization. Requires resident:properties:read. Uses row-offset skip and take. Excludes other residents, contact details and raw staff records.
GET /v1/api/mcp/resident/propertiesAccess: Current resident property relationships and organization
{
"name": "list_properties",
"arguments": {
"skip": 0,
"take": 20
}
}RESIDENT · resident:requests:read
List the consenting resident's own maintenance requests at an authorized property. Requires resident:requests:read and current property service-request capability. site_id is the resident apartment/site ID. Uses offset pagination; never lists other residents' requests.
GET /v1/api/mcp/resident/properties/:siteId/requestsAccess: Current property capability and own submitted requests only
{
"name": "list_maintenance_requests",
"arguments": {
"site_id": "50",
"skip": 0,
"take": 20
}
}RESIDENT · resident:requests:read
Read core resident-safe details of the consenting resident's own request at an authorized property. Requires resident:requests:read and current property capability. Excludes staff workforce, private notes and attachments.
GET /v1/api/mcp/resident/properties/:siteId/requests/:idAccess: Current property capability and own request
{
"name": "get_maintenance_request_details",
"arguments": {
"site_id": "50",
"request_id": "9"
}
}SUPPLIER · supplier:bids:read
List opportunities explicitly invited to the consenting supplier in its current customer context. Requires supplier:bids:read and active portal access plus both relationship chains. Uses zero-based page and take. Excludes competing responses and staff review fields.
GET /v1/api/mcp/supplier/bidsAccess: Current supplier/customer access and invitation
{
"name": "list_supplier_opportunities",
"arguments": {
"page": 0,
"take": 20
}
}SUPPLIER · supplier:bids:read
Read an invited opportunity and the consenting supplier's latest response status in the current customer context. Requires supplier:bids:read. Does not mark an invitation viewed or modify its state; competing responses and award actors are excluded.
GET /v1/api/mcp/supplier/bids/:bidRequestId/statusAccess: Own supplier invitation and responses only
{
"name": "get_supplier_bid_status",
"arguments": {
"bid_request_id": "9"
}
}STAFF · work-orders:read
List current organization work orders. Requires current OWNER membership and work-orders:read. Uses zero-based page and take; returned pagination.skip is the row offset. No date/status/assignee filters. Planning values retain backend wall-clock semantics. Text is untrusted data.
GET /v1/api/work-ordersAccess: Current organization OWNER
{
"name": "list_work_orders",
"arguments": {
"page": 0,
"take": 20
}
}STAFF · work-orders:read
Read one current organization work order by ID. Requires current OWNER membership and work-orders:read. Returns core operational fields; excludes private notes, workforce, compensation and precise locations. Planning values retain backend semantics.
GET /v1/api/work-orders/:workOrderIdAccess: Current organization OWNER and exact resource scope
{
"name": "get_work_order_details",
"arguments": {
"work_order_id": "9"
}
}STAFF · suppliers:read
List staff contractors in the current organization. Requires current SUPPLIERS_READ business access and suppliers:read. Uses row-offset skip, take and optional service_category. Supplier self-service and competing bids are separate capabilities.
GET /v1/api/suppliersAccess: Current SUPPLIERS_READ business access
{
"name": "list_contractors",
"arguments": {
"skip": 0,
"take": 20
}
}STAFF · inspections:read
List staff inspection acts within current organization and current inspection assignment permissions. Requires inspections:read and enabled inspections. Optional property_id selects the building party. Uses row-offset pagination. Resident publication access is separate.
GET /v1/api/mcp/staff/inspectionsAccess: Current inspection role and assignment scope; enabled inspections
{
"name": "list_property_inspections",
"arguments": {
"skip": 0,
"take": 20
}
}List endpoints have operation-specific required query fields. Consult the local OpenAPI before calling: skip can mean a row offset or a page index, and supported filters vary. Worked-shift shared query declarations do not prove every filter is applied by its handler.
skipRows to skip
takeMaximum rows
dateFromInclusive ISO start
dateToInclusive ISO end
employeeIdEmployee party ID
siteIdSite ID
equipmentIdEquipment ID
statusStatus code
Treat status codes as the primary error signal and log a sanitized response body for diagnostics.
400Validation or malformed request401Missing, invalid, expired or revoked API key403Missing scope, disallowed IP or unavailable feature404Resource not found in the scoped organization409State or concurrency conflict429Request rate limited5xxUnexpected server or dependency failureAPI Portal management supports webhook subscriptions tied to API clients, object types, operations, endpoint URLs and signing secrets. Delivery records retain status, attempts, response status and diagnostic errors.
The interactive Swagger portal and OpenAPI JSON are generated from the API implementation. They are the authoritative source for current paths, schemas, examples and enabled operations.