API Portal + MCP Gateway · OpenAPI 3.0.3 · v1.3.0

Kurkite su ConnectMe veiklos platforma

Kurkite ConnectMe integracijas pagal API vadovus autentifikacijai, darbuotojams, CRM, objektams, įrangai, darbams, patikroms ir ataskaitoms.

Base URL

https://demo.connectme.work/v1/api
21API domains
36Scopes
2auth headers

Du prisijungimo būdai

Kviečiame integruoti AI asistentus, agentus ir platformas. Aptarkime jūsų integraciją.
Quickstart

Your first request

  1. 1

    Create an API client

    In ConnectMe, open Setup → API Portal → Management and create a client for one integration.

  2. 2

    Grant minimum scopes

    Select only the read and write scopes required for that integration.

  3. 3

    Store the key securely

    The cm_live_ key is a secret. Keep it server-side and never embed it in browser or mobile code.

  4. 4

    Call the API

    Send the key as a Bearer token or X-API-Key header to the organization-scoped endpoint.

cURL
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'
JavaScript
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();

Authentication

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.

Bearer headerAuthorization: Bearer cm_live_...
API-key headerX-API-Key: cm_live_...

Security checklist

  • Create a separate API client for every integration and environment.
  • Grant least-privilege scopes rather than the wildcard scope.
  • Use allowed IPs where the integration has stable egress addresses.
  • Set expiration dates and rotate keys on a defined schedule.
  • Keep keys in a secret manager or protected server environment.
  • Revoke a key immediately if it may have been exposed.
  • Monitor last-used dates and disable abandoned clients.
Authorization

Fine-grained scopes

Most domains provide separate :read and :write scopes. A request returns 403 when its API client does not contain every required scope.

absences:readabsences:writeagreements:readagreements:writeattachments:readbuilding-finance:readbuilding-finance:writebuilding-management:readbuilding-management:syncbuilding-management:writebuilding-ownership:readbuilding-ownership:writeclients:readclients:writecompensation:readcompensation:writecontacts:readcontacts:writeemployees:reademployees:writeexpenses:readinspections:readinspections:writelocations:readmaterials:readmaterials:writesetup:readsetup:writesites:readsites:writesuppliers:readsuppliers:writetime:readwork-order-reports:readwork-orders:readwork-orders:write
API domains

Endpoint guide

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 schemas

144 of 144 methods

MCP delegated reads

7 endpoints
GET/mcp/staff/inspections/{actId}mcpGetStaffInspectioninspections:readDelegated MCP only · API keys rejected
GET/mcp/resident/propertiesmcpListResidentPropertiesresident:properties:readDelegated MCP only · API keys rejected
GET/mcp/resident/properties/{siteId}/requestsmcpListResidentRequestsresident:requests:readDelegated MCP only · API keys rejected
GET/mcp/resident/properties/{siteId}/requests/{id}mcpGetResidentRequestresident:requests:readDelegated MCP only · API keys rejected
GET/mcp/supplier/bidsmcpListSupplierOpportunitiessupplier:bids:readDelegated MCP only · API keys rejected
GET/mcp/supplier/bids/{bidRequestId}/statusmcpGetOwnSupplierBidStatussupplier:bids:readDelegated MCP only · API keys rejected
GET/mcp/staff/inspectionsList currently authorized staff inspectionsinspections:readDelegated MCP only · API keys rejected
inspections:readresident:properties:readresident:requests:readsupplier:bids:read

External building finance

9 endpoints
GET/building-finance/importsList normalized financial importsbuilding-finance:read
POST/building-finance/importsStage a normalized building-finance documentbuilding-finance:write
POST/building-finance/imports/{id}/documentUpload invoice PDF bytesbuilding-finance:write
POST/building-finance/paymentsImport payment allocationsbuilding-finance:write
GET/building-finance/provider-identitiesList provider identity mappingsbuilding-finance:read
PUT/building-finance/provider-identitiesBind a provider identitybuilding-finance:write
GET/building-management/buildings/{buildingPartyId}/apartments/{siteId}/financial-documentsList canonical apartment billsbuilding-finance:read
GET/building-management/buildings/{buildingPartyId}/apartments/{siteId}/paymentsList canonical apartment paymentsbuilding-finance:read
GET/building-management/financial-documents/{id}/detailsGet canonical bill detailsbuilding-finance:read
building-finance:readbuilding-finance:write

External employees

5 endpoints
GET/employeesList employeesemployees:read
POST/employeesCreate employee and invitation useremployees:write
GET/employees/{employeeId}Get employeeemployees:read
PATCH/employees/{employeeId}Update employeeemployees:write
POST/employees/{employeeId}/discontinueEnd-date employee and user loginemployees:write
employees:reademployees:write

External time

2 endpoints
GET/time/worked-shiftsGet worked shifts and reported entriestime:read
GET/time/summaryGet worked-time and pay summary by employeetime:read
time:read

External expenses

1 endpoints
GET/expensesList expense headers and linesexpenses:read
expenses:read

External absences

5 endpoints
GET/absencesList vacations and absencesabsences:read
POST/absencesCreate vacation or absenceabsences:write
GET/absences/{absenceId}Get absenceabsences:read
PATCH/absences/{absenceId}Update absenceabsences:write
DELETE/absences/{absenceId}Delete absenceabsences:write
absences:readabsences:write

External CRM clients

7 endpoints
GET/clientsList CRM clientsclients:read
POST/clientsCreate CRM clientclients:write
GET/clients/{clientId}Get CRM client detailsclients:read
PATCH/clients/{clientId}Update CRM clientclients:write
GET/clients/{clientId}/sitesList sites for CRM clientsites:read
POST/clients/{clientId}/sitesCreate site for CRM clientsites:write
PATCH/clients/{clientId}/sites/{siteId}Update site for CRM clientsites:write
clients:readclients:writesites:readsites:write

External CRM contacts

4 endpoints
GET/clients/{clientId}/contactsList contacts for CRM clientcontacts:read
POST/clients/{clientId}/contactsCreate contact for CRM clientcontacts:write
GET/contactsList CRM contactscontacts:read
PATCH/contacts/{contactPointId}Update CRM contactcontacts:write
contacts:readcontacts:write

External CRM locations

1 endpoints
GET/locationsList CRM site locationslocations:read
locations:read

External CRM

4 endpoints
GET/sitesList organization sitessites:read
POST/sitesCreate organization site with locationsites:write
GET/sites/{siteId}Get organization sitesites:read
PATCH/sites/{siteId}Update organization sitesites:write
sites:readsites:write

External setup

5 endpoints
GET/sites/{siteId}/equipmentList equipmentsetup:read
POST/sites/{siteId}/equipmentCreate equipmentsetup:write
GET/sites/{siteId}/equipment/{equipmentId}Get equipmentsetup:read
PATCH/sites/{siteId}/equipment/{equipmentId}Update equipmentsetup:write
DELETE/sites/{siteId}/equipment/{equipmentId}Delete equipmentsetup:write
setup:readsetup:write

External compensation

3 endpoints
GET/compensationsList compensation definitionscompensation:read
POST/compensationsCreate compensation definitioncompensation:write
POST/employees/{employeeId}/compensationsAssign compensation to employeecompensation:write
compensation:readcompensation:write

External materials

4 endpoints
GET/materialsList materialsmaterials:read
POST/materialsCreate materialmaterials:write
GET/materials/{materialId}Get materialmaterials:read
PATCH/materials/{materialId}Update materialmaterials:write
materials:readmaterials:write

External suppliers

6 endpoints
GET/suppliersList supplierssuppliers:read
POST/suppliersCreate suppliersuppliers:write
GET/suppliers/{supplierPartyId}Get supplier detailssuppliers:read
GET/suppliers/{supplierPartyId}/employeesList supplier employeessuppliers:read
POST/suppliers/{supplierPartyId}/employeesCreate supplier employeesuppliers:write
PATCH/suppliers/{supplierPartyId}/employees/{employeePartyId}Update supplier employeesuppliers:write
suppliers:readsuppliers:write

External agreements

7 endpoints
GET/suppliers/{supplierPartyId}/agreementsList agreements for supplieragreements:read
GET/agreementsList agreementsagreements:read
POST/agreementsCreate agreementagreements:write
GET/agreements/statsGet agreement expiry statisticsagreements:read
GET/agreements/{agreementId}Get agreementagreements:read
PATCH/agreements/{agreementId}Update agreementagreements:write
DELETE/agreements/{agreementId}Terminate agreementagreements:write
agreements:readagreements:write

External work orders

6 endpoints
GET/work-ordersList CRM work orderswork-orders:read
POST/work-ordersCreate CRM work orderwork-orders:write
GET/work-orders/{workOrderId}Get CRM work orderwork-orders:read
PATCH/work-orders/{workOrderId}Update CRM work orderwork-orders:write
GET/clients/{clientId}/work-ordersList CRM client work orderswork-orders:read
GET/sites/{siteId}/work-ordersList CRM site work orderswork-orders:read
work-orders:readwork-orders:write

External work order reporting

8 endpoints
GET/work-orders/{workOrderId}/statisticsGet work order statisticswork-order-reports:read
GET/clients/{clientId}/work-orders/statisticsGet client work order statisticswork-order-reports:read
GET/sites/{siteId}/work-orders/statisticsGet site work order statisticswork-order-reports:read
GET/clients/{clientId}/sites/{siteId}/work-orders/statisticsGet client-site work order statisticswork-order-reports:read
GET/work-orders/{workOrderId}/report/pdfDownload work order PDF reportwork-order-reports:read
GET/work-orders/{workOrderId}/report/excelDownload work order Excel reportwork-order-reports:read
GET/work-orders/{workOrderId}/report/csvDownload work order CSV reportwork-order-reports:read
GET/clients/{clientId}/work-orders/statistics/report/pdfDownload client work order statistics PDF reportwork-order-reports:read
work-order-reports:read

External building management

38 endpoints
GET/building-management/buildings/{buildingPartyId}/apartments/{siteId}/meter-readingsList apartment meter readingsbuilding-management:read
POST/building-management/buildings/{buildingPartyId}/apartments/{siteId}/meter-readingsCreate apartment meter readingbuilding-management:write
GET/building-management/buildings/{buildingPartyId}/apartments/{siteId}/metersList configured apartment metersbuilding-management:read
POST/building-management/buildings/{buildingPartyId}/apartments/{siteId}/metersCreate an apartment meterbuilding-management:write
PATCH/building-management/buildings/{buildingPartyId}/apartments/{siteId}/meters/{meterId}Update an apartment meterbuilding-management:write
POST/building-management/buildings/{buildingPartyId}/apartments/{siteId}/meter-readings/{id}/correctionsCorrect an apartment meter readingbuilding-management:write
GET/building-management/buildings/{buildingPartyId}/metersList communal building metersbuilding-management:read
POST/building-management/buildings/{buildingPartyId}/metersCreate communal building meterbuilding-management:write
PATCH/building-management/buildings/{buildingPartyId}/meters/{meterId}Update communal building meterbuilding-management:write
GET/building-management/buildings/{buildingPartyId}/meter-readingsList communal building meter readingsbuilding-management:read
POST/building-management/buildings/{buildingPartyId}/meter-readingsCreate communal building meter readingbuilding-management:write
GET/building-management/buildings/{clientId}/apartments/{siteId}/personsList apartment owners, tenants, payers, and contactsbuilding-management:read
POST/building-management/buildings/{clientId}/apartments/{siteId}/personsCreate apartment person relationshipbuilding-management:write
PATCH/building-management/buildings/{clientId}/apartments/{siteId}/persons/{relationshipId}Update apartment person relationshipbuilding-management:write
DELETE/building-management/buildings/{clientId}/apartments/{siteId}/persons/{relationshipId}End apartment person relationshipbuilding-management:write
GET/building-management/buildings/{buildingPartyId}/house-seniorsList house senior assignments for buildingbuilding-management:read
POST/building-management/buildings/{buildingPartyId}/house-seniorsAssign house senior to buildingbuilding-management:write
PATCH/building-management/buildings/{buildingPartyId}/house-seniors/{relationshipId}Update house senior assignmentbuilding-management:write
DELETE/building-management/buildings/{buildingPartyId}/house-seniors/{relationshipId}End house senior assignmentbuilding-management:write
PATCH/building-management/meter-readings/{id}Update meter readingbuilding-management:write
DELETE/building-management/meter-readings/{id}Delete meter readingbuilding-management:write
GET/building-management/buildings/{buildingPartyId}/financial-documentsList building financial documentsbuilding-management:read
POST/building-management/buildings/{buildingPartyId}/financial-documentsCreate building financial documentbuilding-management:write
PATCH/building-management/financial-documents/{id}Update financial documentbuilding-management:write
DELETE/building-management/financial-documents/{id}Delete financial documentbuilding-management:write
GET/building-management/buildings/{buildingPartyId}/paymentsList building paymentsbuilding-management:read
POST/building-management/buildings/{buildingPartyId}/paymentsCreate building paymentbuilding-management:write
PATCH/building-management/payments/{id}Update paymentbuilding-management:write
DELETE/building-management/payments/{id}Delete paymentbuilding-management:write
GET/building-management/buildings/{buildingPartyId}/tasksList building CRM tasksbuilding-management:read
POST/building-management/buildings/{buildingPartyId}/tasksCreate building CRM taskbuilding-management:write
PATCH/building-management/tasks/{id}Update building CRM taskbuilding-management:write
GET/building-management/notificationsList building notificationsbuilding-management:read
POST/building-management/notificationsCreate or queue building notificationbuilding-management:write
PATCH/building-management/notifications/{id}Update or send draft building notificationbuilding-management:write
DELETE/building-management/notifications/{id}Delete draft building notificationbuilding-management:write
GET/building-management/sync-attemptsList building-management sync attemptsbuilding-management:sync
POST/building-management/sync/{objectType}/{id}Synchronize one building-management objectbuilding-management:sync
building-management:readbuilding-management:writebuilding-management:sync

External building ownership

3 endpoints
GET/building-management/buildings/{buildingPartyId}/apartments/{siteId}/agreementsList apartment ownership and tenancy agreementsbuilding-ownership:read
POST/building-management/buildings/{buildingPartyId}/apartments/{siteId}/agreementsCreate an apartment ownership or tenancy agreementbuilding-ownership:write
PATCH/building-management/apartment-agreements/{agreementId}Update an apartment agreementbuilding-ownership:write
building-ownership:readbuilding-ownership:write

External inspections

18 endpoints
GET/inspections/buildingsList inspection buildingsinspections:read
GET/inspections/buildings/{clientId}/historyList building inspection historyinspections:read
GET/inspections/buildings/{clientId}/work-ordersList inspection work orders for buildinginspections:read
GET/inspections/work-orders/{workOrderId}/detailsGet section-scoped inspection details for a work orderinspections:read
GET/inspections/act-templatesList inspection act templatesinspections:read
GET/inspections/actsList inspection actsinspections:read
POST/inspections/actsCreate inspection actinspections:write
GET/inspections/acts/{actId}Get inspection act detailsinspections:read
PATCH/inspections/acts/{actId}Update inspection actinspections:write
PUT/inspections/acts/{actId}/valuesReplace inspection act valuesinspections:write
POST/inspections/acts/{actId}/evidenceAdd inspection evidence metadatainspections:write
GET/inspections/acts/{actId}/defectsList inspection defectsinspections:read
POST/inspections/acts/{actId}/defectsCreate inspection defectinspections:write
GET/inspections/acts/{actId}/work-ordersList work orders linked to inspection actinspections:read
POST/inspections/acts/{actId}/work-ordersCreate work order from inspection actinspections:write, work-orders:write
POST/inspections/acts/{actId}/section-work-ordersCreate section work orders for one inspection actinspections:write, work-orders:write
GET/inspections/acts/{actId}/statisticsGet inspection act rollup statisticsinspections:read
GET/inspections/acts/{actId}/versionsList inspection act versionsinspections:read
inspections:readinspections:writework-orders:write

External attachments

1 endpoints
GET/attachmentsList attachment metadataattachments:read
attachments:read

MCP Gateway · v0.3.0 · Streamable HTTP

Read-only tools for AI assistants

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.

Connect

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.

Discover and call

Initialize an MCP client, then use tools/list and tools/call. Discovery only returns tools allowed by your grant. Operational write tools are unavailable.

Bounded reads

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

get_property_inspection_details

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/:actId

Access: Current inspection role and assignment scope; enabled inspections; exact resource

{
  "name": "get_property_inspection_details",
  "arguments": {
    "act_id": "70"
  }
}

RESIDENT · resident:properties:read

list_properties

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/properties

Access: Current resident property relationships and organization

{
  "name": "list_properties",
  "arguments": {
    "skip": 0,
    "take": 20
  }
}

RESIDENT · resident:requests:read

list_maintenance_requests

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/requests

Access: Current property capability and own submitted requests only

{
  "name": "list_maintenance_requests",
  "arguments": {
    "site_id": "50",
    "skip": 0,
    "take": 20
  }
}

RESIDENT · resident:requests:read

get_maintenance_request_details

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/:id

Access: Current property capability and own request

{
  "name": "get_maintenance_request_details",
  "arguments": {
    "site_id": "50",
    "request_id": "9"
  }
}

SUPPLIER · supplier:bids:read

list_supplier_opportunities

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/bids

Access: Current supplier/customer access and invitation

{
  "name": "list_supplier_opportunities",
  "arguments": {
    "page": 0,
    "take": 20
  }
}

SUPPLIER · supplier:bids:read

get_supplier_bid_status

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/status

Access: Own supplier invitation and responses only

{
  "name": "get_supplier_bid_status",
  "arguments": {
    "bid_request_id": "9"
  }
}

STAFF · work-orders:read

list_work_orders

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-orders

Access: Current organization OWNER

{
  "name": "list_work_orders",
  "arguments": {
    "page": 0,
    "take": 20
  }
}

STAFF · work-orders:read

get_work_order_details

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/:workOrderId

Access: Current organization OWNER and exact resource scope

{
  "name": "get_work_order_details",
  "arguments": {
    "work_order_id": "9"
  }
}

STAFF · suppliers:read

list_contractors

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/suppliers

Access: Current SUPPLIERS_READ business access

{
  "name": "list_contractors",
  "arguments": {
    "skip": 0,
    "take": 20
  }
}

STAFF · inspections:read

list_property_inspections

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/inspections

Access: Current inspection role and assignment scope; enabled inspections

{
  "name": "list_property_inspections",
  "arguments": {
    "skip": 0,
    "take": 20
  }
}

Pagination and filtering

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.

skip

Rows to skip

take

Maximum rows

dateFrom

Inclusive ISO start

dateTo

Inclusive ISO end

employeeId

Employee party ID

siteId

Site ID

equipmentId

Equipment ID

status

Status code

HTTP errors

Treat status codes as the primary error signal and log a sanitized response body for diagnostics.

400Validation or malformed request
401Missing, invalid, expired or revoked API key
403Missing scope, disallowed IP or unavailable feature
404Resource not found in the scoped organization
409State or concurrency conflict
429Request rate limited
5xxUnexpected server or dependency failure

Webhooks and synchronization

API 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.

  • Use a dedicated HTTPS endpoint.
  • Validate the configured signing secret.
  • Return a successful response promptly.
  • Make consumers idempotent because delivery can be retried.
  • Record object ID and operation before processing.
  • Monitor failed delivery attempts in API Portal.

Use the generated contract

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.