The Composity REST API enables interaction with business data across all modules, including Accounts, Deals, Sales, Items, Projects, Expenses, and more. Each module is accessible via predefined endpoints that support standard HTTP methods for performing create, read, update, and delete (CRUD) operations.

Important Notes:

• All endpoints are prefixed with:
  https://api.composity.cloud/
• Resources in the API are typically named as nouns, such as accounts, deals, or projects. Subresources may be nested (e.g., form under accounts).
• Actions primarily follow conventional HTTP methods:
  • GET – retrieve data
  • POST – create or update data
  • DELETE – remove data
    Any deviations from this convention are explicitly documented per endpoint.
• All endpoints include a db value in the URL path. This identifies the workspace (also referred to as the database) that the request is scoped to.
  For example:
  https://api1.composity.cloud/composity/api/expense
  In this case, composity is the value of db, used to define which workspace the API call affects.

• All responses are returned in JSON format.

  
  Swagger Documentation

• For interactive testing and reference, Composity provides a Swagger documentation
  

• Using Swagger:

• Specify the db name in the workspace field when testing endpoints.

• Provide authorization using a Bearer token.

  • To generate an API key for the token, go to your Composity profile, scroll to Settings, and generate a new API key.

• Include the generated key in the Authorization header for your requests:

   

  Authorization: Bearer <your_api_key>