> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ones1ght.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API · OData Connector

> Call an HTTP API or OData service live at query time and register it as a data source.

## Overview

The API connector connects to an HTTP API or an OData service.
It does not copy and store your data — it **calls the API live at query time.**

> [!NOTE]
>
> This screen is available to **Manager and above** (owner, manager) only. Menu visibility `manage`.

## Steps

**1. Request · paging**

Configure the request to call and the paging method.

**2. Response · drill**

Test the call and drill into the response to locate the data.

**3. Data view · filter**

Review the preview and add filters so only matching rows are used.

**4. Field mapping**

For each column, set a Meaning (required, standard field name) and Detail (optional).

**5. Register**

Enter a name and register the data source.

## HTTP API

| Item | Description |
| - | - |
| Method | `GET` / `POST` only (read-only) |
| URL | Target address |
| Headers | Optional — e.g. authentication |
| Query params | Optional |
| Body (JSON) | `POST` only |

> [!NOTE]
>
> REQUEST fields are all optional — you can call with just the URL.

## OData

**1. Enter service URL**

Enter the OData service root URL.

**2. Connect & list entity sets**

Connect, then select an entity set. The method is fixed to `GET`, and cursor paging is the default.

## Paging

| Method | Description |
| - | - |
| None | No paging |
| Parameter (offset · page) | Repeat calls with page/size parameters |
| Next link · cursor | Follow the response's next link (e.g. `@odata.nextLink`) |

## Response handling

After a test call, set the response type: Auto-detect / JSON / CSV / Excel. For JSON responses, drill into the location to select the data.

## Security

> [!WARNING]
>
> Credentials such as headers and body are **encrypted with AES-256-GCM** and are never returned to the client.
> When editing, leaving a field blank keeps the stored value.

> [!WARNING]
>
> Calls to internal or private addresses are not allowed.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.