Ninox API
Ninox API as documented publicly: 25 operations. Contract generated from the documentation by API Evangelist (2026-10-24); not the provider's own document.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/ninoxdb-de:ninoxdb-de-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.1.0
info:
title: Ninox API
version: '2026-10-24'
description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-24: 25 operation(s) read from 39 public documentation page(s) (each
operation names its page in x-source). This is not the provider''s published contract; Ninox has published no machine-readable contract that
the pipeline could find. Engine: local.'
x-evidence-tiers:
code-example: 0
documentation: 25
pages-with-code: 0
pages-read: 39
x-generated-from: documentation
x-provenance: generated
x-authored-by: API Evangelist
x-generated: '2026-10-24'
x-generator: generate-contract-from-docs.py
x-engine: local
x-sources:
- https://docs.ninox.com/ninox-api/api-reference/api-endpoints.md
- https://docs.ninox.com/ninox-api/api-reference/api-endpoints/files.md
- https://docs.ninox.com/ninox-api/api-reference/api-endpoints/views.md
- https://docs.ninox.com/ninox-api/api-reference/api-endpoints/fields.md
- https://docs.ninox.com/ninox-api/api-reference/api-endpoints/models.md
- https://docs.ninox.com/ninox-api/api-reference/api-endpoints/script.md
- https://docs.ninox.com/ninox-api/api-reference/api-endpoints/tables.md
- https://docs.ninox.com/ninox-api/api-reference/api-endpoints/modules.md
- https://docs.ninox.com/ninox-api/api-reference/api-endpoints/records.md
- https://docs.ninox.com/ninox-api/api-reference/api-endpoints/reports.md
- https://docs.ninox.com/ninox-api/api-reference/api-endpoints/workspace.md
- https://docs.ninox.com/ninox-api/api-reference/api-endpoints/global-functions.md
- https://docs.ninox.com/ninox-api/api-reference/introduction-to-ninox-public-api.md
- https://docs.ninox.com/ninox-api/api-reference/api-endpoints/pages-and-components.md
- https://docs.ninox.com/ninox-api/readme.md
- https://docs.ninox.com/builder-hub/design-your-app/add-and-edit-data-fields-in-your-tables/all-data-fields/link-one-record-reference.md
- https://docs.ninox.com/getting-started/ninox-api-getting-started/intro-to-the-ninox-api.md
- https://docs.ninox.com/getting-started/builder-getting-started/quickstart-create-your-first-app.md
- https://docs.ninox.com/builder-hub/manage-your-organization-and-workspace/backup-and-restore-your-data.md
- https://docs.ninox.com/builder-hub/manage-your-organization-and-workspace/organize-your-workspace/api-and-connections.md
- https://docs.ninox.com/getting-started/basics/glossary.md
- https://docs.ninox.com/getting-started/getting-started.md
- https://docs.ninox.com/getting-started/user-getting-started/main-elements-of-ninox.md
- https://docs.ninox.com/getting-started/builder-getting-started/intro-to-the-ninox-ui.md
- https://docs.ninox.com/getting-started/builder-getting-started/set-up-your-ninox-manually.md
- https://docs.ninox.com/getting-started/user-getting-started/basic-actions-you-need-to-know.md
- https://docs.ninox.com/getting-started/builder-getting-started/intro-to-the-ninox-ui/ninox-ai.md
- https://docs.ninox.com/getting-started/builder-getting-started/use-a-template-for-your-first-app.md
- https://docs.ninox.com/getting-started/builder-getting-started/intro-to-the-ninox-ui/ninox-ai/prompting.md
- https://docs.ninox.com/getting-started/builder-getting-started/set-up-your-ninox-manually/your-first-app.md
- https://docs.ninox.com/getting-started/builder-getting-started/set-up-your-ninox-manually/your-first-automations.md
- https://docs.ninox.com/getting-started/builder-getting-started/intro-to-the-ninox-ui/app-screen-your-main-working-screen.md
- https://docs.ninox.com/getting-started/builder-getting-started/set-up-your-ninox-manually/invite-your-team-and-assign-roles.md
- https://docs.ninox.com/getting-started/builder-getting-started/set-up-your-ninox-manually/your-first-organization-and-workspace.md
- https://docs.ninox.com/getting-started/builder-getting-started/intro-to-the-ninox-ui/settings-screen-user-organization-workspace.md
- https://docs.ninox.com/getting-started/builder-getting-started/set-up-your-ninox-manually/create-print-layouts-and-generate-pdfs.md
- https://docs.ninox.com/getting-started/builder-getting-started/intro-to-the-ninox-ui/main-navigation-settings-profile-and-global-menu.md
- https://docs.ninox.com/getting-started/builder-getting-started/intro-to-the-ninox-ui/workspace-home-inbox-documents-bookmarks-and-history.md
- https://docs.ninox.com/builder-hub/manage-your-organization-and-workspace/organize-your-workspace/api-and-connections/manage-workspace-level-connections.md
paths:
/api/v1/workspace/{workspaceid}/modules/{modulename}/definition:
get:
operationId: get_api_v1_workspace_workspaceid_modules_modulename_definition
tags:
- Api
summary: GET /api/v1/workspace/{workspaceid}/modules/{modulename}/definition
x-source: https://docs.ninox.com/ninox-api/api-reference/api-endpoints/modules.md
parameters:
- name: workspaceid
in: path
required: true
schema:
type: string
- name: modulename
in: path
required: true
schema:
type: string
responses:
'200':
description: Success (status as documented)
content:
application/json:
schema:
$ref: '#/components/schemas/GetApiV1WorkspaceWorkspaceidModulesModulenameDefinitionRespo'
x-evidence:
kind: documentation
/builder-hub/design-your-app/add-and-edit-data-fields-in-your-tables/all-data-fields/link-one-record-reference.md:
get:
operationId: get_builder_hub_design_your_app_add_and_edit_data_fields_in_your_tables_all_data
tags:
- Builder Hub
summary: Link one record (Reference)
description: Performs an HTTP GET request on the documentation page to retrieve its content, optionally with `ask` and `goal` query parameters
for contextual answers.
x-source: https://docs.ninox.com/builder-hub/design-your-app/add-and-edit-data-fields-in-your-tables/all-data-fields/link-one-record-reference.md
parameters:
- name: ask
in: query
required: false
schema:
type: string
description: The immediate question to ask the documentation.
- name: goal
in: query
required: false
schema:
type: string
description: The overall goal the user wants to achieve.
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
/builder-hub/manage-your-organization-and-workspace/backup-and-restore-your-data.md:
get:
operationId: get_builder_hub_manage_your_organization_and_workspace_backup_and_restore_your_d
tags:
- Builder Hub
summary: Backup and restore your data
x-source: https://docs.ninox.com/builder-hub/manage-your-organization-and-workspace/backup-and-restore-your-data.md
parameters:
- name: ask
in: query
required: true
schema:
type: string
description: The immediate question, specific and self‑contained, written in natural language.
- name: goal
in: query
required: true
schema:
type: string
description: The user’s overall goal, describing the desired outcome rather than restating the question.
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
/builder-hub/manage-your-organization-and-workspace/organize-your-workspace/api-and-connections.md:
get:
operationId: get_builder_hub_manage_your_organization_and_workspace_organize_your_workspace_a
tags:
- Builder Hub
summary: API and connections
x-source: https://docs.ninox.com/builder-hub/manage-your-organization-and-workspace/organize-your-workspace/api-and-connections.md
parameters:
- name: ask
in: query
required: false
schema:
type: string
description: The immediate question to ask the documentation.
- name: goal
in: query
required: false
schema:
type: string
description: The overall goal of the user, used to tailor the answer.
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
? /builder-hub/manage-your-organization-and-workspace/organize-your-workspace/api-and-connections/manage-workspace-level-connections.md
: get:
operationId: get_builder_hub_manage_your_organization_and_workspace_organize_your_workspace_a
tags:
- Builder Hub
summary: Manage workspace-level connections
description: Perform an HTTP GET request on the documentation page with the `ask` and `goal` query parameters to retrieve a direct answer
and relevant excerpts.
x-source: https://docs.ninox.com/builder-hub/manage-your-organization-and-workspace/organize-your-workspace/api-and-connections/manage-workspace-level-connections.md
parameters:
- name: ask
in: query
required: true
schema:
type: string
description: The immediate question to ask the documentation.
- name: goal
in: query
required: true
schema:
type: string
description: The overall goal the user wants to achieve.
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
/getting-started/basics/glossary.md:
get:
operationId: get_getting_started_basics_glossary_md
tags:
- Getting Started
summary: Glossary
x-source: https://docs.ninox.com/getting-started/basics/glossary.md
parameters:
- name: ask
in: query
required: false
schema:
type: string
description: The immediate question to ask the documentation.
- name: goal
in: query
required: false
schema:
type: string
description: The broader goal behind the question.
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
/getting-started/builder-getting-started/intro-to-the-ninox-ui.md:
get:
operationId: get_getting_started_builder_getting_started_intro_to_the_ninox_ui_md
tags:
- Getting Started
summary: Intro to the Ninox UI
x-source: https://docs.ninox.com/getting-started/builder-getting-started/intro-to-the-ninox-ui.md
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
/getting-started/builder-getting-started/intro-to-the-ninox-ui/app-screen-your-main-working-screen.md:
get:
operationId: get_getting_started_builder_getting_started_intro_to_the_ninox_ui_app_screen_you
tags:
- Getting Started
summary: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters.
x-source: https://docs.ninox.com/getting-started/builder-getting-started/intro-to-the-ninox-ui/app-screen-your-main-working-screen.md
parameters:
- name: ask
in: query
required: false
schema:
type: string
description: The immediate question, specific and self‑contained.
- name: goal
in: query
required: false
schema:
type: string
description: The user’s overall goal, describing the desired outcome.
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
/getting-started/builder-getting-started/intro-to-the-ninox-ui/main-navigation-settings-profile-and-global-menu.md:
get:
operationId: get_getting_started_builder_getting_started_intro_to_the_ninox_ui_main_navigatio
tags:
- Getting Started
summary: Main navigation - settings, profile, and global menu
description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
excerpts from the documentation.
x-source: https://docs.ninox.com/getting-started/builder-getting-started/intro-to-the-ninox-ui/main-navigation-settings-profile-and-global-menu.md
parameters:
- name: ask
in: query
required: false
schema:
type: string
description: The immediate question, specific and self‑contained.
- name: goal
in: query
required: false
schema:
type: string
description: The user’s overall goal, describing the desired outcome.
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
/getting-started/builder-getting-started/intro-to-the-ninox-ui/ninox-ai.md:
get:
operationId: get_getting_started_builder_getting_started_intro_to_the_ninox_ui_ninox_ai_md
tags:
- Getting Started
summary: Ninox AI
x-source: https://docs.ninox.com/getting-started/builder-getting-started/intro-to-the-ninox-ui/ninox-ai.md
parameters:
- name: ask
in: query
required: false
schema:
type: string
description: The immediate question, specific and self‑contained, written in natural language.
- name: goal
in: query
required: false
schema:
type: string
description: The user’s ultimate goal, describing the outcome they want to achieve.
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
/getting-started/builder-getting-started/intro-to-the-ninox-ui/ninox-ai/prompting.md:
get:
operationId: get_getting_started_builder_getting_started_intro_to_the_ninox_ui_ninox_ai_promp
tags:
- Getting Started
summary: Prompting
description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
excerpts from the documentation.
x-source: https://docs.ninox.com/getting-started/builder-getting-started/intro-to-the-ninox-ui/ninox-ai/prompting.md
parameters:
- name: ask
in: query
required: false
schema:
type: string
description: The immediate question, specific and self‑contained.
- name: goal
in: query
required: false
schema:
type: string
description: The user’s overall goal, describing the outcome they want.
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
/getting-started/builder-getting-started/intro-to-the-ninox-ui/settings-screen-user-organization-workspace.md:
get:
operationId: get_getting_started_builder_getting_started_intro_to_the_ninox_ui_settings_scree
tags:
- Getting Started
summary: Settings screen - user, organization, workspace
x-source: https://docs.ninox.com/getting-started/builder-getting-started/intro-to-the-ninox-ui/settings-screen-user-organization-workspace.md
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
/getting-started/builder-getting-started/intro-to-the-ninox-ui/workspace-home-inbox-documents-bookmarks-and-history.md:
get:
operationId: get_getting_started_builder_getting_started_intro_to_the_ninox_ui_workspace_home
tags:
- Getting Started
summary: Workspace home - inbox, documents, bookmarks, and history
description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer from the documentation.
x-source: https://docs.ninox.com/getting-started/builder-getting-started/intro-to-the-ninox-ui/workspace-home-inbox-documents-bookmarks-and-history.md
parameters:
- name: ask
in: query
required: false
schema:
type: string
description: The immediate question to ask the documentation.
- name: goal
in: query
required: false
schema:
type: string
description: The broader goal the user wants to achieve.
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
/getting-started/builder-getting-started/quickstart-create-your-first-app.md:
get:
operationId: get_getting_started_builder_getting_started_quickstart_create_your_first_app_md
tags:
- Getting Started
summary: Quickstart - create your first app
description: Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters to retrieve answers from the documentation.
x-source: https://docs.ninox.com/getting-started/builder-getting-started/quickstart-create-your-first-app.md
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
/getting-started/builder-getting-started/set-up-your-ninox-manually.md:
get:
operationId: get_getting_started_builder_getting_started_set_up_your_ninox_manually_md
tags:
- Getting Started
summary: Set up your Ninox manually
description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
excerpts from the documentation.
x-source: https://docs.ninox.com/getting-started/builder-getting-started/set-up-your-ninox-manually.md
parameters:
- name: ask
in: query
required: false
schema:
type: string
description: The immediate question, specific and self‑contained, written in natural language.
- name: goal
in: query
required: false
schema:
type: string
description: The user’s ultimate goal, describing the outcome they want to achieve.
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
/getting-started/builder-getting-started/set-up-your-ninox-manually/create-print-layouts-and-generate-pdfs.md:
get:
operationId: get_getting_started_builder_getting_started_set_up_your_ninox_manually_create_pr
tags:
- Getting Started
summary: Create print layouts and generate PDFs
x-source: https://docs.ninox.com/getting-started/builder-getting-started/set-up-your-ninox-manually/create-print-layouts-and-generate-pdfs.md
parameters:
- name: ask
in: query
required: false
schema:
type: string
description: The immediate question to ask the documentation.
- name: goal
in: query
required: false
schema:
type: string
description: The broader goal behind the question.
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
/getting-started/builder-getting-started/set-up-your-ninox-manually/invite-your-team-and-assign-roles.md:
get:
operationId: get_getting_started_builder_getting_started_set_up_your_ninox_manually_invite_yo
tags:
- Getting Started
summary: Invite your team and assign roles
x-source: https://docs.ninox.com/getting-started/builder-getting-started/set-up-your-ninox-manually/invite-your-team-and-assign-roles.md
parameters:
- name: ask
in: query
required: false
schema:
type: string
description: The immediate question to ask the documentation.
- name: goal
in: query
required: false
schema:
type: string
description: The user’s overall goal for the request.
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
/getting-started/builder-getting-started/set-up-your-ninox-manually/your-first-organization-and-workspace.md:
get:
operationId: get_getting_started_builder_getting_started_set_up_your_ninox_manually_your_firs
tags:
- Getting Started
summary: Your first organization and workspace
x-source: https://docs.ninox.com/getting-started/builder-getting-started/set-up-your-ninox-manually/your-first-organization-and-workspace.md
parameters:
- name: ask
in: query
required: true
schema:
type: string
description: The immediate question to ask the documentation.
- name: goal
in: query
required: true
schema:
type: string
description: The overall goal the user wants to achieve with the answer.
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
/getting-started/builder-getting-started/use-a-template-for-your-first-app.md:
get:
operationId: get_getting_started_builder_getting_started_use_a_template_for_your_first_app_md
tags:
- Getting Started
summary: Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters
description: The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
x-source: https://docs.ninox.com/getting-started/builder-getting-started/use-a-template-for-your-first-app.md
parameters:
- name: ask
in: query
required: true
schema:
type: string
description: The immediate question, specific and self‑contained, written in natural language.
- name: goal
in: query
required: true
schema:
type: string
description: The user’s ultimate goal, describing the outcome they want to achieve.
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
/getting-started/getting-started.md:
get:
operationId: get_getting_started_getting_started_md
tags:
- Getting Started
summary: Getting started
description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer from the documentation.
x-source: https://docs.ninox.com/getting-started/getting-started.md
parameters:
- name: ask
in: query
required: false
schema:
type: string
description: The immediate question, specific and self‑contained.
- name: goal
in: query
required: false
schema:
type: string
description: The user’s overall goal, describing the desired outcome.
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
/getting-started/ninox-api-getting-started/intro-to-the-ninox-api.md:
get:
operationId: get_getting_started_ninox_api_getting_started_intro_to_the_ninox_api_md
tags:
- Getting Started
summary: Intro to the Ninox API
description: Perform an HTTP GET request on the documentation page with `ask` and `goal` query parameters to retrieve a direct answer and
relevant excerpts from the documentation.
x-source: https://docs.ninox.com/getting-started/ninox-api-getting-started/intro-to-the-ninox-api.md
parameters:
- name: ask
in: query
required: false
schema:
type: string
description: The immediate question, specific and self‑contained, written in natural language.
- name: goal
in: query
required: false
schema:
type: string
description: The user’s overall goal, describing the outcome they want to achieve.
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
/getting-started/user-getting-started/basic-actions-you-need-to-know.md:
get:
operationId: get_getting_started_user_getting_started_basic_actions_you_need_to_know_md
tags:
- Getting Started
summary: Basic actions you need to know
x-source: https://docs.ninox.com/getting-started/user-getting-started/basic-actions-you-need-to-know.md
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
/getting-started/user-getting-started/main-elements-of-ninox.md:
get:
operationId: get_getting_started_user_getting_started_main_elements_of_ninox_md
tags:
- Getting Started
summary: Main elements of Ninox
description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
excerpts from the documentation.
x-source: https://docs.ninox.com/getting-started/user-getting-started/main-elements-of-ninox.md
parameters:
- name: ask
in: query
required: false
schema:
type: string
description: The immediate question, specific and self‑contained, written in natural language.
- name: goal
in: query
required: false
schema:
type: string
description: The user’s ultimate goal, describing the outcome they want to achieve.
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
/ninox-api/api-reference/introduction-to-ninox-public-api.md:
get:
operationId: get_ninox_api_api_reference_introduction_to_ninox_public_api_md
tags:
- Ninox Api
summary: Introduction to Ninox public API
description: Perform an HTTP GET request on the documentation page with optional `ask` and `goal` query parameters to retrieve a direct
answer and relevant excerpts.
x-source: https://docs.ninox.com/ninox-api/api-reference/introduction-to-ninox-public-api.md
parameters:
- name: ask
in: query
required: false
schema:
type: string
description: The immediate question, specific and self‑contained, written in natural language.
- name: goal
in: query
required: false
schema:
type: string
description: The ultimate goal of the user, describing the outcome they want to achieve.
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
/ninox-api/readme.md:
get:
operationId: get_ninox_api_readme_md
tags:
- Ninox Api
summary: Find everything you need to start building with the Ninox API.
description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
excerpts from the documentation.
x-source: https://docs.ninox.com/ninox-api/readme.md
parameters:
- name: ask
in: query
required: false
schema:
type: string
description: The immediate question; specific, self‑contained, natural language.
- name: goal
in: query
required: false
schema:
type: string
description: The user’s overall goal, describing the desired outcome.
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
components:
schemas:
GetApiV1WorkspaceWorkspaceidModulesModulenameDefinitionRespo:
type: object
properties:
'200':
type: string
description: Definition retrieved
'401':
type: string
description: Unauthorized
'404':
type: string
description: Module not found
'500':
type: string
description: Internal server error
tags:
- name: Api
- name: Builder Hub
- name: Getting Started
- name: Ninox Api