Workspace

Get workspace details

get

Retrieves comprehensive details about a workspace, including all its modules

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

Workspace details 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}

HTTPcURLJavaScriptPython

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

{
  "data": {
    "modules": [
      {
        "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"
            ]
          }
        ]
      }
    ],
    "name": "text"
  }
}