> 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-connections/manage-workspace-level-connections.md).

# Manage workspace-level connections

Connect external systems to your workspace and manage their capabilities.

Connectors link your workspace to supported external systems. You can use their capabilities in Ninox Script to read and write data.

{% hint style="info" %}
A connector is available only in the workspace where you create it.

To create and manage organization-level connectors, see [Manage organization-wide connections](/builder-hub/manage-your-organization-and-workspace/manage-your-organization/manage-organization-wide-connections.md).
{% endhint %}

Supported connectors include Google Sheets, Microsoft Excel, Lexware Office, sevdesk, weclapp, Xentral, and Sage Accounting. You can also configure a custom connector.

{% hint style="info" %}
Connector availability and limits depend on your plan. In **Organization settings**, open **Subscription and usage** to check **Number of connections** and **Connector calls**.
{% endhint %}

{% hint style="warning" %}
A workspace connector can expose connected-system data to anyone who can run scripts in that workspace. Only connect accounts whose data every relevant workspace user may access.
{% endhint %}

### Create a connector

Create a connector from workspace settings or directly from an app.

{% tabs %}
{% tab title="From workspace settings" %}
{% stepper %}
{% step %}

#### Open Connections

Open **Settings** from the main navigation.

Under **WORKSPACE**, select **API and connections**. Select the **Connections** tab.
{% endstep %}

{% step %}

#### Start a connection

Click **+ Create connection**.

Select the connector for the external system you want to connect.
{% endstep %}

{% step %}

#### Connect the external system

Click **Connect**.

Enter a **Connection name** and complete the required setup for the selected system.

Click **Connect** again to finish.
{% endstep %}
{% endstepper %}
{% endtab %}

{% tab title="From an app" %}
{% stepper %}
{% step %}

#### Open the create menu

Open the app where you want to use the connector.

Click the arrow next to **Create table**.

Alternatively, click <i class="fa-ellipsis-vertical">:ellipsis-vertical:</i> **More** in the top bar.&#x20;
{% endstep %}

{% step %}

#### Choose a connector

Under **Connect live data**, select **Google Sheets** or **Microsoft Excel**.

To choose another connector, select **More connections**. Then select the connector you need.
{% endstep %}

{% step %}

#### Configure the connection

Enter a **Connection name** and complete the required setup for the selected system.

Click **Connect** to finish.

The connection is added to the current workspace.
{% endstep %}
{% endstepper %}
{% endtab %}
{% endtabs %}

### Authenticate a connector

Authentication requirements depend on the connector. Follow the setup prompts and provide the required details for the selected system.

#### API key authentication

* **Lexware Office:** Generate a private API key in the [Lexware Office API settings](https://app.lexware.de/addons/public-api). See the [Lexware API documentation](https://developers.lexware.io/docs/#lexware-api-documentation).
* **sevdesk:** Generate an API token. See the [sevdesk authentication documentation](https://api.sevdesk.de/#section/Authentication-and-Authorization).
* **weclapp:** Provide a tenant ID and API key. Your tenant ID is the first part of your weclapp URL. Generate an API token in **My settings** under **API token**. See the [weclapp API documentation](https://www.weclapp.com/api/).
* **Xentral:** Provide a tenant ID and API key. Your tenant ID is the first part of your Xentral URL. Generate a personal access token in **Developer Settings > Personal Access Tokens**. See [Creating personal access tokens](https://help.xentral.com/hc/en-us/articles/6575192352796-Creating-personal-access-tokens-Legacy).

#### OAuth authentication

* **Google Sheets:** Authenticate through redirect or register your own OAuth application. See [Create an OAuth 2.0 client ID](https://support.google.com/cloud/answer/15549257?sjid=13234270053207448225-EU).
* **Microsoft Excel:** Authenticate through redirect and authorize the connection with your account.
* **Sage Accounting:** Authenticate through redirect and authorize the connection with your account.

### Manage connectors in workspace settings

Open **Settings** from the main navigation. Under **WORKSPACE**, select **API and connections**, then select the **Connections** tab.

The screen lists connectors created in the current workspace and organization-level connectors available to it. Use the search field to find a connection by name.

For each connector, the list shows:

* **Connection name** and an icon for the connected system.
* **Who logs in:** the account type selected when the connection was created: **Individual**, **Organization**, or **Workspace**
* **Status** indicates the connection state:
  * **Not connected:** the connection is available in this workspace but still needs an external-system account. To connect it, click the <i class="fa-link">:link:</i> icon.
  * **Active:** a working credential and a successful last connection or call
  * **Reconnect required:** the provider rejected the credential. Sign in again.
  * **Setup incomplete**: the provider setup for this connection is missing or incomplete. Check the client ID and secret.&#x20;
  * **Unavailable:** the plan does not include the connector, or the provider has no usable capabilities
* **Created on:** the date and time when the connection was created.

To view available **Capabilities** and examples of how to use the connector in Ninox scripts, click the <i class="fa-rectangle-list">:rectangle-list:</i> icon at the end of its row.\
Find more information about using connectors in Ninox Script [here](/builder-hub/manage-your-organization-and-workspace/organize-your-workspace/api-and-connections/manage-workspace-level-connections.md#use-a-connector-in-ninox-script).

To delete a workspace-level connection, click the <i class="fa-trash">:trash:</i> icon in its row.

To disconnect an active connection, click the <i class="fa-link-slash">:link-slash:</i> icon in its row. Disconnecting removes the external-system authentication but keeps the connection available to reconnect. Deleting removes a workspace-level connection entirely.

{% hint style="info" %}
Deleting and disconnecting are available only for connectors created in this workspace. If either icon is unavailable, the connector was created at the organization level. Delete or disconnect it from the organization-level **Connections** screen.
{% endhint %}

### Use a connector in Ninox Script

Call a connector capability with `connectionInvoke()`. Use the connection name you set during configuration and a capability shown in **Capabilities**.

```ninox
connectionInvoke({
    connection: "Lexware Office",
    capability: "customers.list"
})
```

This example calls the `customers.list` capability for the connection named "Lexware Office".

Capability names are system-specific. For example, a connector can provide separate read and write capabilities for customers, suppliers, or invoices.


---

# 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-connections/manage-workspace-level-connections.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.
