API and integrations

Create, review, and revoke workspace API keys for the Ninox public API.

Use API & integrations to manage API access for one workspace. Here you create, review, and revoke API keys for the Ninox public API, which lets external systems access workspace data programmatically.

In API & integrations you can:

• create API keys for external tools

• review each key's scope, expiry, creator, and creation date

• revoke keys you no longer need

You can also open Swagger UI or download the JSON schema and YAML schema.

Each API key only works in the current workspace.

Create an API key

Create one key per integration. This makes review and revocation easier.

1

Open API & integrations

If you are not already on the settings screen, click the gear icon Settings in the main navigation.

Under WORKSPACE, select API & integrations.

2

Start the key creation

Click Create API key.

3

Enter the key details

In API key name, enter a descriptive name for the key. Use a name that helps you identify the integration or purpose later.

In Expiration date, select the date and time when the key should expire. To keep the key without an expiration date, leave this field empty.

4

Create the key

Click Create API key.

Use the key in the external system that calls the Ninox API.

Review API keys

Use the key list to review all API access for the workspace.

For each key, Ninox shows:

• API key name

• Scope

• Expires at

• Created by

• Created at

Review this list regularly to remove old or unused access.

Revoke an API key

Revoke a key when an integration is retired, replaced, or no longer trusted.

1

Open the key list

Open API & integrations under WORKSPACE.

2

Select the key

Find the key you want to remove. Open its action menu or select it in the list.

3

Revoke the key

Choose the revoke action.

Open the API reference

Use the links at the top of the screen when you build or test an integration.

• Swagger UI opens the interactive API reference.

• JSON schema provides the API schema in JSON format.

• YAML schema provides the API schema in YAML format.

You can track workspace API usage in Subscriptions and usage.