> For the complete documentation index, see [llms.txt](https://docs.ninox.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ninox.com/builder-hub/manage-your-organization-and-workspace/organize-your-workspace/api-and-integrations.md).

# 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**.

{% hint style="info" %}
Each API key only works in the current workspace.
{% endhint %}

### Create an API key

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

{% stepper %}
{% step %}

#### 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**.
{% endstep %}

{% step %}

#### Start the key creation

Click **Create API key**.
{% endstep %}

{% step %}

#### 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.
{% endstep %}

{% step %}

#### Create the key

Click **Create API key**.

Use the key in the external system that calls the Ninox API.
{% endstep %}
{% endstepper %}

### 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.

{% stepper %}
{% step %}

#### Open the key list

Open **API & integrations** under **WORKSPACE**.
{% endstep %}

{% step %}

#### Select the key

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

{% step %}

#### Revoke the key

Choose the revoke action.
{% endstep %}
{% endstepper %}

### 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](/builder-hub/manage-your-organization-and-workspace/manage-your-organization/subscriptions-and-usage.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.ninox.com/builder-hub/manage-your-organization-and-workspace/organize-your-workspace/api-and-integrations.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.