Ninox integration: operations for AI agents
Ninox connects to Type.com as an integration. This page lists the 56 operations documented for Claude and Codex in Type.com: 21 read, 22 write, 13 destructive.
About Ninox
Ninox is a low-code platform that enables users to create custom database applications tailored to their specific needs.
Categories: Developer Tools & IT
How to connect Ninox to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
56 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
56 operations listed.
Historical Pipedream actions
- Destructive
Create Record
Creates a record. See docs here
- Destructive
Update Record
Updates a record. See docs here
Ninox4 / Pages & Components
- Read
Get a specific page or component
Retrieves a specific page or component by id
GET /api/v1/workspace/{workspaceId}/components/{componentId} - Write
Create a page or component
Creates a page or component in a module. Page, Container, Tabs, Accordion, Text, Button, FieldComponent, DynamicHTMLComponent, CustomWidget, MetricCardComponent, ChartComponent, TableComponent, KanbanComponent, GanttComponent, CalendarComponent and MapComponent can be created through the public API today. Every kind except Page must nest under an existing component via parentId.
POST /api/v1/workspace/{workspaceId}/modules/{moduleName}/components - Write
Update a page or component
Updates a page or component. Only the kinds listed on create can be written through the public API today; changing an existing component's type to anything else is refused, and so is a stored component whose type is already unsupported.
PATCH /api/v1/workspace/{workspaceId}/components/{componentId} - Destructive
Delete a page or component
Deletes a page or component, and every component nested under it
DELETE /api/v1/workspace/{workspaceId}/components/{componentId}
Ninox4 / Fields
- Read
List all fields in a table
Retrieves all fields defined in a table. Each field in the response includes type-specific properties: `options` (array for choice/multi, expression string for dchoice/dmulti), `optionName` / `optionIcon` / `optionColor` for dchoice/dmulti, and `expression` for function fields. Any configured `canRead` / `canWrite` permission guards are included for every type.
GET /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/fields - Read
Get a specific field
Retrieves detailed information about a specific field in a table. For choice/multi fields the response includes an `options` array with stable ids. For dchoice/dmulti fields the response includes the `options` expression and any configured `optionName`, `optionIcon`, `optionColor` formulas. For function fields the response includes the `expression`. Any configured `canRead` / `canWrite` permission guards are included for every type.
GET /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/fields/{fieldName} - Write
Create a field
Creates a new field in a table. **Choice / multi fields:** provide an `options` array with initial values. Each option receives a server-assigned stable `id` returned in the response. **Dynamic choice / dmulti fields:** `options` is required and must be an expression that resolves the selectable records at runtime. `optionName`, `optionIcon`, and `optionColor` are optional display-value expressions. **Logic (function) fields:** `expression` is optional. **Every script property is compiled before the field is created:** `expression`, `options`, `optionName`, `optionIcon`, `optionColor`, `canRead` and `canWrite` are all Ninox Script expressions, and an expression that does not parse returns 400 with nothing created — a broken one would otherwise degrade the field silently on every read instead of failing loudly while it can still be fixed. `canRead`/`canWrite` are evaluated per record, so they can permit the field on one record and refuse it on the next; `canWrite` is rejected for computed and system-generated types (`function`, `lambda`, `reverse`, `rowId`, `void`), which have no write path to guard, and setting either requires the `schema:manage-permissions` grant. On create, none of these can reference the field being created — it is not yet in the table's script scope; set such an expression with a follow-up PATCH. **Not creatable via this endpoint:** `any`, `lambda`, `react`, `rowId`, `styled`, `unknown`, `void` are internal script-type artifacts with no UI presence (`lambda` has no storage column at all) — intentionally excluded, not a gap.
POST /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/fields - Write
Create multiple fields (batch)
Creates multiple fields in a table within a single transaction. If any field creation fails, all changes are rolled back. The same rules as the single-create endpoint apply per field: choice/multi fields accept an initial `options` array; dchoice/dmulti fields require an `options` expression; logic fields accept an optional `expression`. Every script property — `expression`, `options`, `optionName`, `optionIcon`, `optionColor`, `canRead`, `canWrite` — is compiled before the transaction, on every field in the batch: one field with an expression that does not parse returns 400 and no field in the batch is created.
POST /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/fields/batch - Destructive
Delete multiple fields (batch)
Deletes multiple fields in a table within a single transaction. If any field deletion fails, all changes are rolled back.
DELETE /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/fields/batch - Destructive
Update multiple fields (batch)
Updates multiple fields in a table within a single transaction. If any field update fails, all changes are rolled back. Same per-field rules as the single-update endpoint apply to each entry — including the `schema:manage-permissions` grant for permission properties and the pre-save compilation of every script property (`expression`, `options`, `optionName`, `optionIcon`, `optionColor`, `canRead`, `canWrite`), any of which rejects the whole batch.
PATCH /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/fields/batch - Destructive
Delete a field
Deletes a field in a table
DELETE /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/fields/{fieldName} - Destructive
Update a field
Updates an existing field in a table. **choice / multi fields:** `options` replaces the full option list. Include the `id` for existing options you want to keep; omit `id` for new options. To change the id of an existing option, send the new id in `id` and the current one in `previousId`, and records holding the old id follow. Sending an options array to a non-choice field or an options expression to a non-dynamic-choice field returns 400. **dchoice / dmulti fields:** `options` updates the selection expression. `optionName`, `optionIcon`, and `optionColor` update the corresponding display-value formulas. `optionName`, `optionIcon`, `optionColor` cannot be sent to non-dynamic-choice fields (returns 400). **Logic (function) fields:** `expression` updates the field's formula. **Every script property is compiled before the update:** `expression`, `options`, `optionName`, `optionIcon`, `optionColor`, `canRead` and `canWrite` are all Ninox Script expressions, and an expression that does not parse returns 400 with nothing changed — a broken one would otherwise degrade the field silently on every read instead of failing loudly while it can still be fixed. `canRead`/`canWrite` are evaluated per record, so send `null` to remove one; `'true'` also stops it refusing anything, but keeps an expression that is still evaluated once per record. An empty string is rejected rather than read as "no guard" — only an absent guard is treated as absent, so a blank expression would be evaluated and would deny every record. `canWrite` is rejected for computed and system-generated types (`function`, `lambda`, `reverse`, `rowId`, `void`), which have no write path to guard and therefore never carry one to clear. Setting or clearing either requires the `schema:manage-permissions` grant.
PATCH /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/fields/{fieldName}
Ninox4 / Files
- Write
Complete a file upload
Confirms a completed direct upload and returns the file-type field value. Pass `documentId`, `documentVersionId`, and `uploadId` from the generate-upload-url step, and the `etags` S3 returned for each uploaded part. The returned object is the complete field value — pass it as-is when creating/updating a record.
POST /api/v1/workspace/{workspaceId}/files/complete - Write
Start a file upload (get presigned URLs)
Generates presigned URLs for uploading a file directly to storage — the first step of a file-type field upload. Upload the file bytes directly to the returned URL(s) (one per part), then call `.../files/complete` with the resulting ETags to finish. This never sends file bytes through this API.
POST /api/v1/workspace/{workspaceId}/files/upload-url - Write
Upload a file to a record
Uploads a file and attaches it to a record in a single multipart/form-data request, with the file in the `file` form field, like the Ninox 3 files endpoint. No presigned URL or complete step is needed. The returned object can also be stored in a file-type field (max. 50 MB).
POST /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/records/{recordId}/files
Ninox4 / Modules
- Read
Get a module definition
Returns every object of a module as one definition that the PUT route applies, in this or another workspace. Custom roles are referenced by name as @role:<name>.
GET /api/v1/workspace/{workspaceId}/modules/{moduleName}/definition - Read
List all modules in a workspace
Retrieves all modules available in a workspace
GET /api/v1/workspace/{workspaceId}/modules - Read
Get a specific module
Retrieves detailed information about a specific module, including its tables
GET /api/v1/workspace/{workspaceId}/modules/{moduleName} - Write
Apply a module definition
Applies a module definition onto an existing module. An empty module gets every object created, flows included. Otherwise an object is matched by its id, or by the object an earlier apply created it from, so a rename in the source updates the copy. The rest are matched by table id, table and field id, table and name (views, reports), name (scripts), and parent, type and name (components); matched objects are updated, the rest created. Nothing is deleted, and flows and the data-model diagram are skipped. Custom roles resolve by name in this workspace; none are created. Applying the same definition twice changes nothing the second time.
PUT /api/v1/workspace/{workspaceId}/modules/{moduleName}/definition - Write
Create a module
Creates a new module in a workspace
POST /api/v1/workspace/{workspaceId}/modules - Write
Update a module
Updates an existing module in a workspace
PATCH /api/v1/workspace/{workspaceId}/modules/{moduleName} - Destructive
Delete a module
Deletes a module in a workspace
DELETE /api/v1/workspace/{workspaceId}/modules/{moduleName} - Destructive
Update module, table, field, and option labels (batch)
Updates labels across a module, its tables, their fields, and choice/multi option labels in a single transaction. Labels are replaced wholesale per object, same as the single-field PATCH — send every locale you want kept, not just the one changing. Every option id in an `options` entry must already exist on that field; an unknown id rejects the whole request. Writes against a synced field are rejected.
PATCH /api/v1/workspace/{workspaceId}/modules/{moduleName}/labels
Ninox4 / Global functions
- Read
List global function scripts
Lists the module's global function scripts, in the name order they compile in
GET /api/v1/workspace/{workspaceId}/modules/{moduleName}/functions - Read
Get a global function script
Retrieves a global function script by name
GET /api/v1/workspace/{workspaceId}/modules/{moduleName}/functions/{scriptName} - Write
Create a global function script
Creates a script of global function definitions, callable from every script of the module. The code may only define functions and is compiled with the functions of the scripts before it by name. Needs schema:write plus records:write.
POST /api/v1/workspace/{workspaceId}/modules/{moduleName}/functions - Write
Update a global function script
Updates or renames a global function script. The result is compiled again with the functions of the scripts before it by name. Scripts after it that call its functions are not checked again. Needs schema:write plus records:write.
PATCH /api/v1/workspace/{workspaceId}/modules/{moduleName}/functions/{scriptName} - Destructive
Delete a global function script
Deletes a global function script. Scripts after it that call its functions are not checked again. Needs records:write
DELETE /api/v1/workspace/{workspaceId}/modules/{moduleName}/functions/{scriptName}
Ninox4 / Reports
- Read
List all reports in a table
Retrieves all reports for a table
GET /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/reports - Read
Get a specific report
Retrieves a specific report by id
GET /api/v1/workspace/{workspaceId}/reports/{reportId} - Read
Print a report
Renders a report for a record (or a merged run across several) as a PDF
POST /api/v1/workspace/{workspaceId}/reports/{reportId}/print - Write
Create a report
Creates a report (print layout) for a table. Omit `objects` to auto-generate a layout from the table's current fields, matching the report designer's automatic layout option.
POST /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/reports
Ninox4 / Records
- Read
Get records from a table
Retrieves paginated rows from a table with optional filtering and sorting. `choice` and `multi` values are returned as option ids (an array of ids for `multi`), the same value a script reads. A filter on a choice field accepts an option id or a label.
GET /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/records - Read
Get a single record from a table
Retrieves a single record by its id. The record id is not a filterable field, so this is the only way to fetch a known record by id.
GET /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/record/{recordId} - Read
Get row changes since a timestamp
Retrieves rows created, updated, or deleted since a given timestamp — for incremental sync. Only available for tables with history tracking enabled; returns 400 otherwise. 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.
GET /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/records/changes - Write
Create records in a table
Creates new records in an existing table (max. 6MB payload size). Values follow the same rules as in the update endpoint. For example an `icon` field takes an icon name or an object `{"icon": "check_circle", "color": "#4CAF50", "filling": 1}`.
POST /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/records - Write
Update records in a table
Updates existing records in a table (max. 6MB payload size). Each record must include an `id` field referencing an existing record. The update is transactional — if any record fails validation or does not exist, all changes are rolled back. **Field type rules:** - `multi` — must be an **array of strings** (e.g. `["Gold", "Silver"]`). A plain string is not accepted. - `choice` — a single string (e.g. `"Gold"`) or an array of strings. - `icon` — an icon name (e.g. `"check_circle"`) or an object `{"icon": "check_circle", "color": "#4CAF50", "filling": 1}`. Any other value is refused with a 400. - `choice` and `multi` values are written as the option **id** or an option label. Reads always return the option **id**, the same value a script reads. The field definition lists each option with its id and labels. - `boolean` — `true` or `false` only; numeric `1`/`0` are not accepted. - `number` — a finite number or a numeric string (e.g. `"42.5"`). - `date` / `timestamp` / `appointment` — ISO 8601 string or Unix timestamp (ms). - Any field may be set to `null` to clear its value.
PATCH /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/records - Write
Import records from CSV file
Import records from a CSV file into an existing table. The endpoint accepts multipart/form-data with: - A CSV file (max 50 MB) - Optional parsing and import options **Auto-mapping**: By default, CSV columns are automatically mapped to table fields by matching column header names to field names (case-insensitive). **Import Modes**: - `append`: Always create new records (default) - `update`: Only update existing records (requires key field mappings) - `upsert`: Update existing records or create new ones (requires key field mappings) **Field Mappings**: Optionally provide explicit mappings to control which CSV columns map to which table fields, and which fields are used as keys for update/upsert operations. **Choice and multi fields**: A cell for a `choice` field holds the option id or an option label, and it is stored as the option id. A cell that matches no option fails the whole import with a 400, and an empty cell is stored as empty. `multi` fields cannot be imported from a CSV cell, so a `multi` column with a value fails the import with a 400. Set `multi` values through the records endpoints. Records read back return the option id for both. The entire import is processed within a single transaction - if any record fails to import, all changes are rolled back.
POST /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/records/import/csv - Write
Upsert records in a table by a unique field
Creates or updates records in a table, matched by a single explicit field (max. 6MB payload size). The match field must be marked `unique: true` on the table. Every record must include a value for the match field. An ambiguous match (more than one existing record with the same value) is rejected with a 409, never resolved silently.
POST /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/records/upsert - Destructive
Delete records from a table
Deletes existing records from a table in a single transaction. If any record id is invalid, does not exist, or deletion fails, all changes are rolled back.
DELETE /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/records
Ninox4 / Script
- Write
Execute a script
Executes a script expression against a record, with writes and trigger cascades enabled — requires the records:write grant. `do as database` is confined to the module named here.
POST /api/v1/workspace/{workspaceId}/script/exec
Ninox4 / Tables
- Read
List all tables in a module
Retrieves all tables within a module
GET /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables - Read
Get a specific table
Retrieves detailed information about a specific table, including its fields
GET /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName} - Write
Create a table
Creates a new table in a module. `canRead`, `canWrite`, `canCreate` and `canDelete` are Ninox Script expressions that must evaluate to a boolean — the operation is allowed only while the expression is truthy. They are evaluated server-side on every row operation, complementing the role lists. Setting any of them (like the role lists) requires an API key with the `schema:manage-permissions` scope. Each guard is compiled before the table is written; one that does not parse is rejected with a 400 rather than stored. At create time the table does not exist yet, so a guard is parsed in module scope only and cannot reference the table own fields — set such a guard with a follow-up PATCH once the fields exist.
POST /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables - Write
Update a table
Updates an existing table in a module. Omitted properties are left unchanged. `canRead`, `canWrite`, `canCreate` and `canDelete` are Ninox Script expressions that must evaluate to a boolean — the operation is allowed only while the expression is truthy. Send `null` to remove a guard entirely; `true` also permits the operation, but stores an expression that is still evaluated once per record. Setting or clearing any of them (like the role lists) requires an API key with the `schema:manage-permissions` scope. Each guard is compiled in the table scope before the update is written; one that does not parse is rejected with a 400 rather than stored. An empty string is not a way to clear a guard and is rejected — only an absent guard is treated as no guard, so a blank expression would be evaluated and would deny every record.
PATCH /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName} - Destructive
Delete a table
Deletes a table in a module
DELETE /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}
Ninox4 / Views
- Read
List all views in a table
Retrieves all views for a table
GET /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/views - Read
Get a specific view
Retrieves a specific view by id
GET /api/v1/workspace/{workspaceId}/views/{viewId} - Read
Export a view to XLSX
Exports a view's rows as an XLSX workbook, with the view's columns in the view's order. Each header is the column's caption in the view, else the field's label, else the field's name. Choice cells hold the option label, and multi-choice cells hold the option labels joined with ", ". Headers and option labels are in the language of the X-App-Language header (default "en"). A label missing in that language falls back to the default label. Labels can repeat, so two columns can share a header. For stable field names and option ids, read the rows from GET /workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/records.
POST /api/v1/workspace/{workspaceId}/export/view/{viewId}/xlsx - Write
Create a view
Creates a view in a table. Every view type can be created, with field references by name.
POST /api/v1/workspace/{workspaceId}/modules/{moduleName}/tables/{tableName}/views - Write
Update a view
Updates a view. Nested configs (chartConfig, ganttConfig, pivot) are merged onto the stored ones, so a PATCH can send just the settings it changes.
PATCH /api/v1/workspace/{workspaceId}/views/{viewId} - Destructive
Delete a view
Deletes a view
DELETE /api/v1/workspace/{workspaceId}/views/{viewId}
Ninox4 / Workspace
- Read
Get schema changes since a timestamp
Retrieves the log of changes to modules, tables, and fields since a given timestamp, for incremental sync. One entry per recorded change, oldest first, so an object edited three times in the window appears three times. 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. Changes older than `meta.retentionCutoff` are no longer available; fetch the full schema instead.
GET /api/v1/workspace/{workspaceId}/schema/changes - Read
Get workspace details
Retrieves comprehensive details about a workspace, including all its modules
GET /api/v1/workspace/{workspaceId}
No operations match.
See How connections work for access and permissions, or browse all integrations.
Reference date: October 28, 2026. Ninox API docs.