# Intro to the Ninox API

The Ninox API is a public interface that allows developers to interact programmatically with Ninox apps. It enables external applications, services, and scripts to securely access, read, and modify data stored in Ninox.

With the API, Ninox becomes more than a standalone platform. It becomes part of a larger ecosystem where your data can flow between systems.

Modern workflows rarely live in a single tool. Teams rely on multiple platforms for automation, analytics, communication, and operations. The Ninox API is designed to make integration with these tools simple and flexible.

### What you can do

* Automate repetitive tasks
* Build custom solutions programmatically
* Simplify migration to Ninox 4

Using the Ninox API, you can:

* Perform CRUD operations on modules
* Perform CRUD operations on tables
* Perform CRUD operations on fields, one by one or in batch
* Perform CRUD operations on records, one by one or in batch
* Import CSV data with `append`, `update`, and `upsert`
* Read workspace information

### What developers should know

These are the main expectations when you build against the API:

* The API is resource-oriented. The core resources are modules, tables, fields, records, and workspaces.
* Requests are sent over HTTPS and use JSON payloads.
* The API uses standard HTTP methods such as `GET`, `POST`, `PATCH`, and `DELETE`.
* Authentication uses a Workspace API Key passed in the request header.
* Each API Key is scoped to one workspace only.
* Some operations on fields and records support batch requests.
* The API is available through Swagger and as OpenAPI in JSON and YAML format.

### How it works

The Ninox API follows a RESTful architecture and communicates over HTTPS. This means:

* Requests are made to specific endpoints
* Data is exchanged in a structured format (typically JSON)
* Standard HTTP methods are used (`GET`, `POST`, `PATCH`, `DELETE`)

All requests require a Workspace API Key passed in the HTTP header. You can generate and manage keys within the "Workspace Integration" settings in the Ninox app.

Each API Key is linked to a specific workspace and grants access to data within that workspace only.

You can discover the Ninox Public API endpoints within a Swagger instance on <https://go.ninox.com/api/docs>.

You can also fetch the OpenAPI specification from <https://go.ninox.com/api/docs-json> or <https://go.ninox.com/api/docs-yaml>.


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.ninox.com/getting-started/ninox-api-getting-started/intro-to-the-ninox-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.