A Company is created when a customer completes an invite link flow. Each company joins your organization to a single integration and exposes connection health, sync activity, and per-model sync configuration.Documentation Index
Fetch the complete documentation index at: https://integrations.docs.commenda.io/llms.txt
Use this file to discover all available pages before exploring further.
Lifecycle
- Invite link created — company record is provisioned with an integration/category.
- Customer connects — platform credentials are stored on the active connection.
- Data syncs — enabled models sync on the configured schedule or via manual sync.
- Disconnect — revoke platform credentials while keeping the company and invite link.
- Archive — soft-delete the company, invite link, and connection.
Companies are scoped to your organization. All company endpoints require the
api_key header. List returns every visible company; detail/update/delete
endpoints require access to that specific company ID.Response envelope
Successful JSON responses are wrapped as:{ "request_id": "uuid" } only. DELETE /core/companies/{company_id} returns 204 No Content with an empty body.
Company object
Both list and detail endpoints return the same serialized company shape.| Field | Type | Description |
|---|---|---|
id | integer | Commenda company ID (rootfi_id). |
companyId | integer | Same as id. |
inviteLinkId | string | null | Invite link UUID, if present. |
companyName | string | null | Display name. |
integration | enum | Connected integration type (e.g. NETSUITE). |
integrationCategory | enum | ACCOUNTING, PAYMENTS, or ECOMMERCE. |
integrationEntityId | string | null | Platform entity identifier, when available. |
connectionStatus | enum | null | Connection health. Null when no connection exists. |
syncStatus | enum | null | Connection sync pipeline status. |
hasActiveSync | boolean | Whether a read sync is currently running. |
lastSynced | string | null | Last successful sync timestamp (ISO 8601). |
syncFrom | string | null | Historical sync start date from invite link. |
createdAt | string | Company creation timestamp (ISO 8601). |
dataModelConfigs | array | Per-model sync config (empty without a connection). |
connection | object | null | Active connection details, when connected. |
dataModelConfigs[] entry includes dataModel, category, enabled, frequency, interval, scopeAccess, syncFrom, isOverridden, and isChild.
Each connection object includes id, createdAt, updatedAt, companyId, organisationId, integrationType, integrationEntityId, category, status, syncStatus, syncResumeAt, lastSynced, and client-safe variables.
Related endpoints
| Action | Endpoint |
|---|---|
| Create company | Invite Links (POST /v4/core/invite-links) |
| List / get / update / archive | Companies endpoints in this section |
| Trigger sync | Sync Data (POST /v4/core/companies/{company_id}/syncs) |