1. Home
  2. Docs
  3. Omaya ( v3 )
  4. Configuration
  5. API


The API module lets you integrate your Omaya platform data with other third party software platform. To access the API module click on Configuration > API from the navigation. On the API listing module, you may search for specific user by using the search field.


The field and its function description is listed below.

API NameThe API name.
API KeyAutomatically generated Omaya API key.
Tenant IDTenant ID to whom API key belongs to.
StatusThe status of API key whether enable or disable.

Modules action :

  • To view detail API.
  • To update the setting of API.
  • To delete the API.


Click on “Add New API” button and populate the required fields. Fill in the field with relevant information to complete the process.



The field and its function description is listed below.

Tenant IDA unique tenant id for each tenant.
API NameThe name for API.
Allowed VenueThe venue allowed for API.

To give access to user

  • Read + Write : Full access
  • Read Only : Read only access
StatusThe status of API whether it is enable or disable.

Permission settings

It display all the available modules in Omaya. Check the modules you want to give permission for API.


Update or Delete API

Click on update or delete icon from the API listing. If you clicked the update icon, the update screen will display where you can update the setting of the API . Click on the delete icon to delete the API. A prompt will be display to ask for your confirmation to proceed to delete the API. Please exercise with cautions as this not a reversible action.