Workspace

Get schema changes since a timestamp

get

Retrieves modules, tables, and fields created, updated, or deleted since a given timestamp — for incremental sync. Pass the response's meta.asOf as since on the next poll to avoid gaps or duplicates. When paging through one poll with limit/offset, also pass the first page's meta.asOf back as asOf on every subsequent page of that same poll.

Authorizations

AuthorizationstringRequired

Enter your Workspace API key.

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

Path parameters

workspaceIdstring · min: 12 · max: 12Required

Workspace ID

Example: 5rdco4s18swuPattern: ^[a-z0-9]+$

Query parameters

asOfstring · date-timeOptional

Pin the poll window to this timestamp (a prior response's meta.asOf) when fetching page 2+ of the same poll; omit on the first page

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

limitnumber · min: 1 · max: 100Optional

Maximum number of changes to return (1-100)

offsetnumberOptional

Number of changes to skip (starts with 0)

sincestring · date-timeRequired

Return changes at or after this ISO 8601 timestamp

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Responses

200

Schema changes retrieved successfully

application/json

400

Bad request (missing since)

application/json

401

Unauthorized

application/json

404

Workspace not found

application/json

get/api/v1/workspace/{workspaceId}/schema/changes

GET /api/v1/workspace/{workspaceId}/schema/changes?since=2026-01-01T00%3A00%3A00.000Z HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "action": "upserted",
      "changedAt": "2026-09-07T10:00:00.000Z",
      "id": "A",
      "kind": "Table"
    }
  ],
  "meta": {
    "asOf": "2026-09-07T10:05:00.000Z"
  },
  "page_info": {
    "has_more": false,
    "limit": 50,
    "offset": 0
  }
}

Get workspace details

get

Retrieves comprehensive details about a workspace, including all its modules

Authorizations

AuthorizationstringRequired

Enter your Workspace API key.

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

Path parameters

workspaceIdstring · min: 12 · max: 12Required

Workspace ID

Example: 5rdco4s18swuPattern: ^[a-z0-9]+$

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}

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

{
  "data": {
    "modules": [
      {
        "hideNavigation": true,
        "icon": {
          "color": "text",
          "filling": 0,
          "icon": "text"
        },
        "isHidden": true,
        "labels": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "name": "text",
        "openRoles": [
          "text"
        ],
        "tables": [
          {
            "createRoles": [
              "text"
            ],
            "deleteRoles": [
              "text"
            ],
            "fields": [
              {
                "expression": "text",
                "expressionErrors": [
                  {
                    "column": 1,
                    "line": 1,
                    "message": "text"
                  }
                ],
                "index": true,
                "labels": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "name": "text",
                "optionColor": "text",
                "optionIcon": "text",
                "optionName": "text",
                "options": [
                  {
                    "color": "text",
                    "icon": "text",
                    "id": "text",
                    "labels": {
                      "ANY_ADDITIONAL_PROPERTY": "text"
                    },
                    "name": "text",
                    "order": 1,
                    "textColor": "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": 0,
              "icon": "text"
            },
            "isEmailLinkingEnabled": true,
            "isHidden": true,
            "labels": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "name": "text",
            "readRoles": [
              "text"
            ],
            "writeRoles": [
              "text"
            ]
          }
        ]
      }
    ],
    "name": "text"
  }
}