Fields

List all fields in a table

get

Retrieves all fields defined in a table

Autorisierungen
AuthorizationstringErforderlich

Enter your Workspace API key.

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

Pfadparameter
tableNameanyErforderlich

Table name

Example: contacts
moduleNameanyErforderlich

Module name

Example: crm
workspaceIdanyErforderlich

Workspace ID

Example: 5rdco4s18swu
Antworten
200

Fields retrieved successfully

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

Create a field

post

Creates a new field in a table

Autorisierungen
AuthorizationstringErforderlich

Enter your Workspace API key.

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

Pfadparameter
tableNameanyErforderlich

Table name

Example: contacts
moduleNameanyErforderlich

Module name

Example: crm
workspaceIdanyErforderlich

Workspace ID

Example: 5rdco4s18swu
Body
namestring · min: 1 · max: 100Erforderlich

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_]+$
oder
anyOptional
typestring · enumErforderlich

Field type

Mögliche Werte:
variantstring · enumOptional

Field variant (for string type)

Mögliche Werte:
indexbooleanOptional

Field is indexed

requiredbooleanOptional

Field is required

searchbooleanOptional

Field is searchable

uniquebooleanOptional

Field is unique

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

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.

Autorisierungen
AuthorizationstringErforderlich

Enter your Workspace API key.

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

Pfadparameter
tableNameanyErforderlich

Table name

Example: contacts
moduleNameanyErforderlich

Module name

Example: crm
workspaceIdanyErforderlich

Workspace ID

Example: 5rdco4s18swu
Bodyobject[]
namestring · min: 1 · max: 100Erforderlich

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_]+$
oder
anyOptional
typestring · enumErforderlich

Field type

Mögliche Werte:
variantstring · enumOptional

Field variant (for string type)

Mögliche Werte:
indexbooleanOptional

Field is indexed

requiredbooleanOptional

Field is required

searchbooleanOptional

Field is searchable

uniquebooleanOptional

Field is unique

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

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.

Autorisierungen
AuthorizationstringErforderlich

Enter your Workspace API key.

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

Pfadparameter
tableNameanyErforderlich

Table name

Example: contacts
moduleNameanyErforderlich

Module name

Example: crm
workspaceIdanyErforderlich

Workspace ID

Example: 5rdco4s18swu
Body
fieldNamesstring[] · min: 1Erforderlich

Field name

Antworten
200

Fields deleted successfully

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

Get a specific field

get

Retrieves detailed information about a specific field in a table

Autorisierungen
AuthorizationstringErforderlich

Enter your Workspace API key.

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

Pfadparameter
fieldNameanyErforderlich

Field name

Example: email
tableNameanyErforderlich

Table name

Example: contacts
moduleNameanyErforderlich

Module name

Example: crm
workspaceIdanyErforderlich

Workspace ID

Example: 5rdco4s18swu
Antworten
200

Field details retrieved successfully

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

Delete a field

delete

Deletes a field in a table

Autorisierungen
AuthorizationstringErforderlich

Enter your Workspace API key.

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

Pfadparameter
fieldNameanyErforderlich

Field name

Example: email
tableNameanyErforderlich

Table name

Example: contacts
moduleNameanyErforderlich

Module name

Example: crm
workspaceIdanyErforderlich

Workspace ID

Example: 5rdco4s18swu
Antworten
200

Field deleted successfully

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

Update a field

patch

Updates an existing field in a table

Autorisierungen
AuthorizationstringErforderlich

Enter your Workspace API key.

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

Pfadparameter
fieldNameanyErforderlich

Field name

Example: email
tableNameanyErforderlich

Table name

Example: contacts
moduleNameanyErforderlich

Module name

Example: crm
workspaceIdanyErforderlich

Workspace ID

Example: 5rdco4s18swu
Body
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

Antworten
200

Field updated successfully

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

Zuletzt aktualisiert

War das hilfreich?