Accessing the API of an App

Some apps allow you to access them via API requests. API capability is useful if you would like to integrate the functionality of the app in your own script or application. To see if an app has API access enabled, go to the app gallery and check the app card for the API menu item.

If API access is enabled, you can add/remove API keys and read the API docs (if they have been set for the app).

To learn how to setup API access for apps as an app administrator, visit our developer docs site (opens in a new tab).

Accessing the App API URL from an API key

To access the App API URL from an API key, follow these steps:

Select an app and open its API settings menu.
Create an API key and copy its value.
Construct the complete API URL.

Example: Your app has /users endpoint and the API URL (from API settings menu) is https://my-app.api.numerous.com (opens in a new tab), so the complete URL is https://my-app.api.numerous.com/users (opens in a new tab) and it can be used to access your API.
Create a request using the complete API URL and the API key. The API key must be passed as Authorization header with Bearer <api_key> value.

The requests can be constructed using Python, JS, etc. For simplicity, we can use curl. Using curl, the API call can look like this:

terminal

$ curl -H "Authorization: Bearer <api_key>" https://my-app.api.numerous.com/users<some_data_returned_>

App Documentation & Release Notes Organizations