Fields

List all fields in a table

get

Retrieves all fields defined in a table

Authorizations

bearer

AuthorizationstringRequired

Enter your Workspace API key.

API keys can be generated and managed within the Workspace Integration settings in the Ninox app.

Path parameters

tableNameanyRequired

Table name

Example: contacts

moduleNameanyRequired

Module name

Example: crm

workspaceIdanyRequired

Workspace ID

Example: 5rdco4s18swu

Responses

200

Fields retrieved successfully

application/json

401

Unauthorized

application/json

404

Table not found

application/json

500

Internal server error

application/json

get

/api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/fields

HTTPcURLJavaScriptPython

GET /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/fields HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "index": true,
      "labels": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "name": "text",
      "readRoles": [
        "text"
      ],
      "refTableId": "text",
      "required": true,
      "search": true,
      "type": "any",
      "unique": true,
      "variant": "text",
      "writeRoles": [
        "text"
      ]
    }
  ]
}

Create a field

post

Creates a new field in a table

Authorizations

bearer

AuthorizationstringRequired

Enter your Workspace API key.

API keys can be generated and managed within the Workspace Integration settings in the Ninox app.

Path parameters

tableNameanyRequired

Table name

Example: contacts

moduleNameanyRequired

Module name

Example: crm

workspaceIdanyRequired

Workspace ID

Example: 5rdco4s18swu

Body

application/json

namestring · min: 1 · max: 100Required

Field name

Pattern: ^[a-z0-9_]+$

refTableNameone ofOptional

Reference table name (for reference/reverse types)

Default: null

string · min: 1 · max: 100OptionalPattern: ^[a-z0-9_]+$

or

anyOptional

typestring · enumRequired

Field type

Possible values:

variantstring · enumOptional

Field variant (for string type)

Possible values:

indexbooleanOptional

Field is indexed

requiredbooleanOptional

Field is required

searchbooleanOptional

Field is searchable

uniquebooleanOptional

Field is unique

Responses

201

Field created successfully

application/json

400

Bad request (e.g., field already exists)

application/json

401

Unauthorized

application/json

404

Workspace, module or table not found

application/json

500

Internal server error

application/json

post

/api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/fields

HTTPcURLJavaScriptPython

POST /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/fields HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 244

{
  "index": true,
  "labels": {
    "": "Description",
    "de": "Beschreibung"
  },
  "name": "description",
  "readRoles": [
    "admin",
    "user"
  ],
  "refTableName": null,
  "required": false,
  "search": true,
  "type": "string",
  "unique": false,
  "variant": "multiline-text",
  "writeRoles": [
    "admin"
  ]
}

Example 1: String Field (with all optional properties)Example 2: Reference FieldExample 3: Number Field

{
  "data": {
    "index": true,
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "name": "text",
    "readRoles": [
      "text"
    ],
    "refTableId": "text",
    "required": true,
    "search": true,
    "type": "any",
    "unique": true,
    "variant": "text",
    "writeRoles": [
      "text"
    ]
  }
}

Create multiple fields (batch)

post

Creates multiple fields in a table within a single transaction. If any field creation fails, all changes are rolled back.

Authorizations

bearer

AuthorizationstringRequired

Enter your Workspace API key.

API keys can be generated and managed within the Workspace Integration settings in the Ninox app.

Path parameters

tableNameanyRequired

Table name

Example: contacts

moduleNameanyRequired

Module name

Example: crm

workspaceIdanyRequired

Workspace ID

Example: 5rdco4s18swu

Bodyobject[]

application/json

namestring · min: 1 · max: 100Required

Field name

Pattern: ^[a-z0-9_]+$

refTableNameone ofOptional

Reference table name (for reference/reverse types)

Default: null

string · min: 1 · max: 100OptionalPattern: ^[a-z0-9_]+$

or

anyOptional

typestring · enumRequired

Field type

Possible values:

variantstring · enumOptional

Field variant (for string type)

Possible values:

indexbooleanOptional

Field is indexed

requiredbooleanOptional

Field is required

searchbooleanOptional

Field is searchable

uniquebooleanOptional

Field is unique

Responses

201

Fields created successfully

application/json

400

Bad request (e.g., validation error, field already exists)

application/json

401

Unauthorized

application/json

404

Workspace, module or table not found

application/json

500

Internal server error

application/json

post

/api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/fields/batch

HTTPcURLJavaScriptPython

POST /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/fields/batch HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 196

[
  {
    "labels": {
      "": "First Name"
    },
    "name": "first_name",
    "type": "string"
  },
  {
    "labels": {
      "": "Last Name"
    },
    "name": "last_name",
    "type": "string"
  },
  {
    "labels": {
      "": "Age"
    },
    "name": "age",
    "required": true,
    "type": "number"
  }
]

Example 1: Basic fieldsExample 2: Email and Number fields with all propertiesExample 3: Text, URL and Reverse fields

{
  "data": [
    {
      "index": true,
      "labels": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "name": "text",
      "readRoles": [
        "text"
      ],
      "refTableId": "text",
      "required": true,
      "search": true,
      "type": "any",
      "unique": true,
      "variant": "text",
      "writeRoles": [
        "text"
      ]
    }
  ]
}

Delete multiple fields (batch)

delete

Deletes multiple fields in a table within a single transaction. If any field deletion fails, all changes are rolled back.

Authorizations

bearer

AuthorizationstringRequired

Enter your Workspace API key.

API keys can be generated and managed within the Workspace Integration settings in the Ninox app.

Path parameters

tableNameanyRequired

Table name

Example: contacts

moduleNameanyRequired

Module name

Example: crm

workspaceIdanyRequired

Workspace ID

Example: 5rdco4s18swu

Body

application/json

fieldNamesstring[] · min: 1Required

Field name

Responses

200

Fields deleted successfully

application/json

400

Bad request (e.g., duplicates in request)

application/json

401

Unauthorized

application/json

404

Field not found

application/json

500

Internal server error

application/json

delete

/api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/fields/batch

HTTPcURLJavaScriptPython

DELETE /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/fields/batch HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "fieldNames": [
    "description",
    "status",
    "assigned_user"
  ]
}

Example 1: Delete basic fieldsExample 2: Delete reference fieldExample 3: Delete mixed field types

{
  "data": [
    {
      "index": true,
      "labels": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "name": "text",
      "readRoles": [
        "text"
      ],
      "refTableId": "text",
      "required": true,
      "search": true,
      "type": "any",
      "unique": true,
      "variant": "text",
      "writeRoles": [
        "text"
      ]
    }
  ]
}

Get a specific field

get

Retrieves detailed information about a specific field in a table

Authorizations

bearer

AuthorizationstringRequired

Enter your Workspace API key.

API keys can be generated and managed within the Workspace Integration settings in the Ninox app.

Path parameters

fieldNameanyRequired

Field name

Example: email

tableNameanyRequired

Table name

Example: contacts

moduleNameanyRequired

Module name

Example: crm

workspaceIdanyRequired

Workspace ID

Example: 5rdco4s18swu

Responses

200

Field details retrieved successfully

application/json

401

Unauthorized

application/json

404

Field not found

application/json

500

Internal server error

application/json

get

/api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/fields/{fieldName}

HTTPcURLJavaScriptPython

GET /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/fields/{fieldName} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "index": true,
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "name": "text",
    "readRoles": [
      "text"
    ],
    "refTableId": "text",
    "required": true,
    "search": true,
    "type": "any",
    "unique": true,
    "variant": "text",
    "writeRoles": [
      "text"
    ]
  }
}

Delete a field

delete

Deletes a field in a table

Authorizations

bearer

AuthorizationstringRequired

Enter your Workspace API key.

API keys can be generated and managed within the Workspace Integration settings in the Ninox app.

Path parameters

fieldNameanyRequired

Field name

Example: email

tableNameanyRequired

Table name

Example: contacts

moduleNameanyRequired

Module name

Example: crm

workspaceIdanyRequired

Workspace ID

Example: 5rdco4s18swu

Responses

200

Field deleted successfully

application/json

401

Unauthorized

application/json

404

Field not found

application/json

500

Internal server error

application/json

delete

/api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/fields/{fieldName}

HTTPcURLJavaScriptPython

DELETE /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/fields/{fieldName} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "index": true,
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "name": "text",
    "readRoles": [
      "text"
    ],
    "refTableId": "text",
    "required": true,
    "search": true,
    "type": "any",
    "unique": true,
    "variant": "text",
    "writeRoles": [
      "text"
    ]
  }
}

Update a field

patch

Updates an existing field in a table

Authorizations

bearer

AuthorizationstringRequired

Enter your Workspace API key.

API keys can be generated and managed within the Workspace Integration settings in the Ninox app.

Path parameters

fieldNameanyRequired

Field name

Example: email

tableNameanyRequired

Table name

Example: contacts

moduleNameanyRequired

Module name

Example: crm

workspaceIdanyRequired

Workspace ID

Example: 5rdco4s18swu

Body

application/json

namestring · min: 1 · max: 100Optional

Field name

Pattern: ^[a-z0-9_]+$

indexbooleanOptional

Field is indexed

requiredbooleanOptional

Field is required

searchbooleanOptional

Field is searchable

uniquebooleanOptional

Field is unique

Responses

200

Field updated successfully

application/json

400

Bad request (e.g., field already exists)

application/json

401

Unauthorized

application/json

404

Field not found

application/json

500

Internal server error

application/json

patch

/api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/fields/{fieldName}

HTTPcURLJavaScriptPython

PATCH /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/fields/{fieldName} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "labels": {
    "": "Updated Label",
    "de": "Aktualisiertes Label"
  },
  "required": true
}

Example 1: Update Labels and Required statusExample 2: Update PermissionsExample 3: Update Name and Searchability

{
  "data": {
    "index": true,
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "name": "text",
    "readRoles": [
      "text"
    ],
    "refTableId": "text",
    "required": true,
    "search": true,
    "type": "any",
    "unique": true,
    "variant": "text",
    "writeRoles": [
      "text"
    ]
  }
}