Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.commenda.io/llms.txt

Use this file to discover all available pages before exploring further.

Base URL: 
https://api.prod.commenda.io/api/v1/partner/commenda-os

​
Authentication

Pass your partner API key in the x-api-key header on every request. 
curl --request GET \
  --url 'https://api.prod.commenda.io/api/v1/partner/commenda-os/customers/77/business-entities' \
  --header 'x-api-key: <partner_api_key>'

​
Response conventions

  • List endpoints return { <resourcePlural>, count }.
  • Detail endpoints return { <resourceSingular> }.
  • All customer-scoped Commenda OS partner endpoints are scoped by customerId.
  • Requests without a valid x-api-key return 401 with Missing x-api-key header or Invalid API key.
  • Customer-scoped endpoints return 403 when the partner cannot access the requested customer.
  • Business-entity-scoped collection endpoints return 404 Business entity not found when the businessEntityId does not belong to the specified customer.
  • Child detail endpoints return resource-specific 404 messages such as Location not found, Government identifier not found, or Registration not found.

​
Available resources