Oomnitza REST APIs

The Oomnitza API v3 is a RESTful interface that enables interaction with resources in Oomnitza. This interface follows REST best practices, to help ensure that creating and updating objects in Oomnitza is as intuitive as possible.

The API supports both HTTP basic and token-based authentication, as well as session-based authentication. All data in transit is securely encrypted via SSL/TLS. The request and response Content-Type values are “application/json”.

The API can be accessed in the Oomnitza WebUI by navigating to Configuration>Integrations>Rest APIs (Swagger Docs).

Using the Oomnitza API

To get started with the API, complete the following steps:

1. In Oomnitza, navigate to Configuration>Integrations>Rest APIs (Swagger Docs).
2. Select your API from the list.
3. Optional: Apply query parameters to narrow your search. Refer to the table below for more information.
4. Click Try it Out and then click Execute. Your response will be provided in the Responses section.

Commonly used query parameters:

• limit
• skip
• sortby
• filter
• fields
• Oomnitza-Ignore-Meta-Restriction

Note
The v4 API for SaaS Users supports the same query parameters and headers as the v3 API. 

To use the API in Postman, complete the following steps.

1. Copy and paste the Request URL directly into Postman 
2. If you are using Basic Authentication, enter your credentials in the form of a username and password by going to Authorization>Basic Auth. If you are using API Key authentication, use Authorization2 as the header key and enter your Oomnitza API token as the value. 
3. Send the API call in Postman. Your response should be identical to the response documented in the Swagger Responses section.

Did you know?
The Oomnitza block is also a convenient way to access our internal Oomnitza APIs. The Oomnitza block enables you to access all of the v3 API endpoints listed in the Swagger documentation, without the need to enter your credentials. For more information, refer to the Oomnitza block.