Skip to main content

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.

An invite link provisions a company and returns inviteLinkId, a UUID used by Connect and the embedded SDK.

Lifecycle

  1. Create — provision company + invite link (POST /v4/core/invite-links).
  2. Share — send inviteLinkId to your customer via Connect/SDK.
  3. Connect — customer authorizes the platform; a connection is created on the company.
  4. Update — adjust company name, syncFrom, or sync config.
  5. Delete — delete the invite link by numeric id.
GET and PATCH use inviteLinkId (UUID). DELETE uses numeric id.

Response envelope

Successful JSON responses are wrapped as:
{
  "data": { ... },
  "request_id": "uuid"
}
DELETE /core/invite-links/{id} returns 204 No Content with an empty body. List and detail responses return these fields:
FieldTypeDescription
idintegerInvite link ID.
inviteLinkIdstring (UUID)Public ID for Connect/SDK.
companyIdinteger | nullProvisioned company ID.
integrationenumIntegration type (e.g. NETSUITE).
integrationCategoryenumACCOUNTING, PAYMENTS, or ECOMMERCE.
syncFromstring | nullHistorical sync start date (ISO 8601).
createdAtstringCreation timestamp (ISO 8601).
GET and PATCH responses also include dataModelConfigs[]. See company sync config. Create returns { id, inviteLinkId, companyId } only.
ActionEndpoint
View companyGet Company
Update syncUpdate Company Sync Config