API Home

Overview

The Kahua API is a RESTful API that provides programatic access to virtually all areas and functions in Kahua, including third-party custom apps built on the Kahua platform. At a high level, the Kahua API consists of two groups of endpoints:

  • Platform APIs: These APIs interact with "core" areas of Kahua that are foundational to the platform and the community centric approach that Kahua uses. This includes API endpoints for things such as company/vendor lists, contacts, projects, and other core concepts of a project management system.

  • App APIs: App APIs provide access to all other Kahua apps. This includes the ability to query data from apps, as well as insert and update data into apps. The approach is the same whether you are working with a standard Kahua app, an extension to a Kahua app, or a third-party custom app.

Postman

Postman is the preferred method used to document and familiarize yourself with the Kahua APIs. Postman provides an easy way for developers to interact with the API in order to develop and tune API requests that may later be used in integrations or data migrations. Kahua provides a Postman collection containing many API samples that developers can use to make ad hoc calls into development environments to test against their own domains and data. Information on setting up Postman can be found here.

The bulk of the API documentation is also contained within the Postman collection. Please refer to the above page on setting up the Postman collection for information on how to access the Postman-based documentation included in the collection.

Authentication

The Kahua APIs use OAuth 2.0 for authorization. OAuth 2.0 credentials can be provisioned in Kahua by a Kahua Domain Administrator. Please refer to Authentication for more details on using OAuth 2.0.

Data Dictionary

Our most common endpoints, the Activity - Inserting and Updating App Data endpoint and Query - Get Data from an App endpoint, require entity definitions which indicate the app and entity data your are working with. Our standard Data Dictionary can help in identifying the entity definition and attribute (fields) that are used for our standard out of box applications, which can be downloaded here.

If you have customizations to our standard applications, or custom apps not included, you can generate a custom data dictionary using the instructions defined Data Dictionary - Get Excel Sheet with App Data.

Entity Markers

Entity Markers provide an efficient way to identify and track changes to virtually any entity (record) in Kahua. Entity Markers are designed and built to help with integrations where a third party or middleware needs to identify records that have changed since the last time integration services ran. Information on entity markers can be found here.

Query endpoint

The Query endpoint in particular is a very flexible endpoint used to query data from any app in Kahua. While there is documentation and several samples of using the query endpoint in the postman collection, this page also contains detailed information on all the capabilities of the query endpoint.

Concurrent Processing

Kahua API's support two concurrent processes per user/token. If needed, users can be added to support more processes.