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 Fields API

The Fields API from Ninox — 3 operation(s) for fields.

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

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

This API exposes 7 operations across 3 paths, and defines 7 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.

7 operations 3 paths 7 schemas 2 DELETE2 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 Fields 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 7

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

Fields 7
POST
/api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/fields
Create a field
FieldsV1Controller_createField 3 params body → 201400401404500
GET
/api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/fields
List all fields in a table
FieldsV1Controller_getFields 3 params → 200401404500
POST
/api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/fields/batch
Create multiple fields (batch)
FieldsV1Controller_createFieldsBatch 3 params body → 201400401404500
DELETE
/api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/fields/batch
Delete multiple fields (batch)
FieldsV1Controller_deleteFieldsBatch 3 params body → 200400401404500
DELETE
/api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/fields/{fieldName}
Delete a field
FieldsV1Controller_deleteField 4 params → 200401404500
GET
/api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/fields/{fieldName}
Get a specific field
FieldsV1Controller_getField 4 params → 200401404500
PATCH
/api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/fields/{fieldName}
Update a field
FieldsV1Controller_updateField 4 params body → 200400401404500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are CreateFieldBody (16 properties), UpdateFieldBody (13 properties), DeleteFieldsBatchBody (1 property), FieldsResponse (1 property). Each schema is shown below with its type and property counts.

FieldResponse
object
1 property 1 required
ErrorResponse
object
1 property 1 required
CreateFieldsBatchBody
array
CreateFieldBody
object
16 properties 3 required
FieldsResponse
object
1 property 1 required
UpdateFieldBody
object
13 properties
DeleteFieldsBatchBody
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ninox-fields-api-openapi.yml Raw ↑

Other APIs Ninox publishes across the network.

Ninox Modules API
Ninox Records API
Ninox Tables API
Ninox Workspace API