Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ninox Records API

The Records API from Ninox — 2 operation(s) for records.

Ninox Records API is one of 5 APIs that Ninox publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Records. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 5 operations across 2 paths, and defines 9 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against the base URL https://go.ninox.com.

5 operations 2 paths 9 schemas 1 DELETE1 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://go.ninox.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Ninox Records API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (API Key) (bearer).

  • bearer — Enter your Workspace API key. API keys can be generated and managed within the Workspace Integration settings in the Ninox app.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 1 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Records 5
POST
/api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/records
Create records in a table
RowsV1Controller_addRows 3 params body → 201400401404
DELETE
/api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/records
Delete records from a table
RowsV1Controller_deleteRows 3 params body → 200400401404
GET
/api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/records
Get records from a table
RowsV1Controller_getRows 8 params → 200401404500
PATCH
/api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/records
Update records in a table
RowsV1Controller_updateRows 3 params body → 200400401404413
POST
/api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/records/import/csv
Import records from CSV file
RowsV1Controller_importCSV 3 params body → 201400401404413500

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are RowsResponse (3 properties), UpdateRowsBody (1 property), UpdateRowsResponse (1 property), DeleteRowsResponse (1 property). Each schema is shown below with its type and property counts.

CreateRowsResponse
object
1 property 1 required
ErrorResponse
object
1 property 1 required
RowsResponse
object
3 properties 2 required
DeleteRowsBody
object
1 property 1 required
AddRowsBody
object
1 property 1 required
DeleteRowsResponse
object
1 property 1 required
UpdateRowsResponse
object
1 property 1 required
UpdateRowsBody
object
1 property 1 required
ImportCSVResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ninox-records-api-openapi.yml Raw ↑

Other APIs Ninox publishes across the network.

Ninox Fields API
Ninox Modules API
Ninox Tables API
Ninox Workspace API