Modules

List all modules in a workspace

get

Retrieves all modules available in a workspace

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

workspaceIdanyRequired

Workspace ID

Example: 5rdco4s18swu

Responses

200

Modules retrieved successfully

application/json

401

Unauthorized

application/json

404

Workspace not found

application/json

500

Internal server error

application/json

get

/api/v1/workspace/{workspaceId}/modules

HTTPcURLJavaScriptPython

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

{
  "data": [
    {
      "hideNavigation": true,
      "icon": {
        "color": "text",
        "filling": 1,
        "icon": "text"
      },
      "isHidden": true,
      "labels": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "name": "text",
      "openRoles": [
        "text"
      ],
      "tables": [
        {
          "createRoles": [
            "text"
          ],
          "deleteRoles": [
            "text"
          ],
          "fields": [
            {
              "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"
              ]
            }
          ],
          "hasFiles": true,
          "hasGlobalSearch": true,
          "hasHistory": true,
          "icon": {
            "color": "text",
            "filling": 1,
            "icon": "text"
          },
          "isEmailLinkingEnabled": true,
          "isHidden": true,
          "labels": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "name": "text",
          "readRoles": [
            "text"
          ],
          "writeRoles": [
            "text"
          ]
        }
      ]
    }
  ]
}

Create a module

post

Creates a new module in a workspace

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

workspaceIdanyRequired

Workspace ID

Example: 5rdco4s18swu

Body

application/json

Create Module request body

namestring · min: 1 · max: 100Required

Module name

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

hideNavigationbooleanOptional

Hide module from navigation

isHiddenbooleanOptional

Hide module

Responses

201

Module created successfully

application/json

400

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

application/json

401

Unauthorized

application/json

404

Workspace not found

application/json

500

Internal server error

application/json

post

/api/v1/workspace/{workspaceId}/modules

HTTPcURLJavaScriptPython

POST /api/v1/workspace/{workspaceId}/modules HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 119

{
  "icon": {
    "color": "#bada55",
    "filling": 0,
    "icon": "favorite"
  },
  "labels": {
    "": "The events module"
  },
  "name": "the_events_module"
}

Example 1Example 2 (all properties)

{
  "data": {
    "hideNavigation": true,
    "icon": {
      "color": "text",
      "filling": 1,
      "icon": "text"
    },
    "isHidden": true,
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "name": "text",
    "openRoles": [
      "text"
    ],
    "tables": [
      {
        "createRoles": [
          "text"
        ],
        "deleteRoles": [
          "text"
        ],
        "fields": [
          {
            "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"
            ]
          }
        ],
        "hasFiles": true,
        "hasGlobalSearch": true,
        "hasHistory": true,
        "icon": {
          "color": "text",
          "filling": 1,
          "icon": "text"
        },
        "isEmailLinkingEnabled": true,
        "isHidden": true,
        "labels": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "name": "text",
        "readRoles": [
          "text"
        ],
        "writeRoles": [
          "text"
        ]
      }
    ]
  }
}

Get a specific module

get

Retrieves detailed information about a specific module, including its tables

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

moduleNameanyRequired

Module name

Example: crm

workspaceIdanyRequired

Workspace ID

Example: 5rdco4s18swu

Responses

200

Module details retrieved successfully

application/json

401

Unauthorized

application/json

404

Module not found

application/json

500

Internal server error

application/json

get

/api/v1/workspace/{workspaceId}/modules/{moduleName}

HTTPcURLJavaScriptPython

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

{
  "data": {
    "hideNavigation": true,
    "icon": {
      "color": "text",
      "filling": 1,
      "icon": "text"
    },
    "isHidden": true,
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "name": "text",
    "openRoles": [
      "text"
    ],
    "tables": [
      {
        "createRoles": [
          "text"
        ],
        "deleteRoles": [
          "text"
        ],
        "fields": [
          {
            "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"
            ]
          }
        ],
        "hasFiles": true,
        "hasGlobalSearch": true,
        "hasHistory": true,
        "icon": {
          "color": "text",
          "filling": 1,
          "icon": "text"
        },
        "isEmailLinkingEnabled": true,
        "isHidden": true,
        "labels": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "name": "text",
        "readRoles": [
          "text"
        ],
        "writeRoles": [
          "text"
        ]
      }
    ]
  }
}

Delete a module

delete

Deletes a module in a workspace

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

moduleNameanyRequired

Module name

Example: crm

workspaceIdanyRequired

Workspace ID

Example: 5rdco4s18swu

Responses

200

Module deleted successfully

application/json

401

Unauthorized

application/json

404

Module not found

application/json

500

Internal server error

application/json

delete

/api/v1/workspace/{workspaceId}/modules/{moduleName}

HTTPcURLJavaScriptPython

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

{
  "data": {
    "id": "text"
  }
}

Update a module

patch

Updates an existing module in a workspace

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

moduleNameanyRequired

Module name

Example: crm

workspaceIdanyRequired

Workspace ID

Example: 5rdco4s18swu

Body

application/json

Update Module request body

namestring · min: 1 · max: 100Optional

Module name

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

hideNavigationbooleanOptional

Hide module from navigation

isHiddenbooleanOptional

Hide module

Responses

200

Module updated successfully

application/json

400

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

application/json

401

Unauthorized

application/json

404

Module not found

application/json

500

Internal server error

application/json

patch

/api/v1/workspace/{workspaceId}/modules/{moduleName}

HTTPcURLJavaScriptPython

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

{
  "hideNavigation": false,
  "icon": {
    "icon": "database"
  },
  "isHidden": false,
  "labels": {
    "": "A new app"
  },
  "name": "a_new_application",
  "openRoles": [
    "editor",
    "admin"
  ]
}

{
  "data": {
    "hideNavigation": true,
    "icon": {
      "color": "text",
      "filling": 1,
      "icon": "text"
    },
    "isHidden": true,
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "name": "text",
    "openRoles": [
      "text"
    ],
    "tables": [
      {
        "createRoles": [
          "text"
        ],
        "deleteRoles": [
          "text"
        ],
        "fields": [
          {
            "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"
            ]
          }
        ],
        "hasFiles": true,
        "hasGlobalSearch": true,
        "hasHistory": true,
        "icon": {
          "color": "text",
          "filling": 1,
          "icon": "text"
        },
        "isEmailLinkingEnabled": true,
        "isHidden": true,
        "labels": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "name": "text",
        "readRoles": [
          "text"
        ],
        "writeRoles": [
          "text"
        ]
      }
    ]
  }
}