Ninox
App · 25 actions
Read and manage Ninox workspaces, modules, tables and records through the current Public API.
Actions
| Action | What it does |
|---|---|
| Create module | Create module. |
| Create records | Create records. |
| Create table | Create table. |
| Delete records | Delete records. |
| Get component | Get component. |
| Get field | Get field. |
| Get function | Get function. |
| Get module | Get module. |
| Get module definition | Get module definition. |
| Get record | Get record. |
| Get report | Get report. |
| Get table | Get table. |
| Get view | Get view. |
| Get workspace | Get workspace. |
| List fields | List fields. |
| List functions | List functions. |
| List modules | List modules. |
| List record changes | List record changes. |
| List records | List records. |
| List reports | List reports. |
| List schema changes | List schema changes. |
| List tables | List tables. |
| List views | List views. |
| Update records | Update records. |
| Upsert records | Upsert records. |
Create module
Create module. Returns one response page; the connected account determines access.
Inputs
- AfterOpen
afterOpentext - Script expression run in the browser each time the app is opened. Needs schema:write plus records:write
- Name
nametextRequired - Module name
- HideNavigation
hideNavigationtrue/false - Hide module from navigation
- Icon
iconobject - Module icon
- IsHidden
isHiddentrue/false - Hide module
- Labels
labelsobject - Module labels (localized)
- OpenRoles
openRoleslist - Module open rolesOne or more of:
admin,editor.
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"data": {
"afterOpen": "example",
"components": [],
"hideNavigation": false,
"icon": {
"color": "example",
"filling": 0,
"icon": "example"
},
"isHidden": false,
"labels": {},
"moduleId": "example",
"name": "example",
"openRoles": [],
"tables": []
}
},
"has_more": false,
"next_cursor": null
}Create records
Create records. Returns one response page; the connected account determines access.
Inputs
- ModuleName
moduleNametextRequired - Module name
- TableName
tableNametextRequired - Table name
- Records
recordslistRequired - Array of records to add to the target table
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"data": {
"ids": []
}
},
"has_more": false,
"next_cursor": null
}Create table
Create table. Returns one response page; the connected account determines access.
Inputs
- ModuleName
moduleNametextRequired - Module name
- Icon
iconobject - Table icon
- Labels
labelsobjectRequired - Table labels (localized)
- Name
nametextRequired - Table name
- CanCreate
canCreatetext - Script expression that must allow creating a record
- CanDelete
canDeletetext - Script expression that must allow deleting a record
- CanRead
canReadtext - Script expression that must allow reading a record
- CanWrite
canWritetext - Script expression that must allow updating a record
- CreateRoles
createRoleslist - Roles allowed to create recordsOne or more of:
admin,editor. - DeleteRoles
deleteRoleslist - Roles allowed to delete recordsOne or more of:
admin,editor. - HasFiles
hasFilestrue/false - Enable files for the table
- HasGlobalSearch
hasGlobalSearchtrue/false - Enable global search for the table
- HasHistory
hasHistorytrue/false - Enable history for the table
- IsEmailLinkingEnabled
isEmailLinkingEnabledtrue/false - Enable email linking for the table
- IsHidden
isHiddentrue/false - Hide the table
- OnCreate
onCreatetext - Script expression run as a trigger after a record is created
- OnDelete
onDeletetext - Script expression run as a trigger when a record is deleted
- OnUpdate
onUpdatetext - Script expression run as a trigger after a record is updated
- ReadRoles
readRoleslist - Roles allowed to read recordsOne or more of:
admin,editor. - WriteRoles
writeRoleslist - Roles allowed to update recordsOne or more of:
admin,editor.
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"data": {
"canCreate": "example",
"canDelete": "example",
"canRead": "example",
"canWrite": "example",
"createRoles": [],
"deleteRoles": [],
"fields": [],
"hasFiles": false,
"hasGlobalSearch": false,
"hasHistory": false,
"icon": {
"color": "example",
"filling": 0,
"icon": "example"
},
"isEmailLinkingEnabled": false,
"isHidden": false,
"labels": {},
"name": "example",
"onCreate": "example",
"onDelete": "example",
"onUpdate": "example",
"readRoles": [],
"writeRoles": []
}
},
"has_more": false,
"next_cursor": null
}Delete records
Delete records. Returns one response page; the connected account determines access.
Inputs
- ModuleName
moduleNametextRequired - Module name
- TableName
tableNametextRequired - Table name
- Records
recordslistRequired - Array of record ids to delete
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"data": {
"deletedIds": []
}
},
"has_more": false,
"next_cursor": null
}Get component
Get component. Returns one response page; the connected account determines access.
Inputs
- ComponentId
componentIdtextRequired - Component ID
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"data": {
"afterHide": "example",
"aggregation": "avg",
"annualRecurring": false,
"arrangement": "grid",
"background": "example",
"beforeShow": "example",
"border": {
"color": "example",
"style": "dashed",
"width": "example"
},
"calendarType": "example",
"cardBorder": "example",
"cardFont": "example",
"cardPadding": 1.0,
"cardRadius": 1.0,
"chartConfig": {
"chartType": "bar",
"dataSets": [],
"donut": false,
"labelPosition": "bottom",
"legend": {
"show": false
},
"limit": 1,
"orientation": "horizontal",
"showDataTable": false,
"showLabels": false,
"showPoints": false,
"showTitle": false,
"smooth": false,
"stacked": false,
"style": "default",
"tooltips": {
"show": false
},
"xAxis": {
"fieldName": "example",
"groupBy": "daily",
"show": false
},
"yAxis": {
"show": false
}
},
"color": "example",
"colorFieldName": "example",
"constraints": "example",
"content": {},
"customStyle": {},
"dataPoint": "conditional",
"defaultValue": false,
"disabled": false,
"display": {
"color": "example",
"format": "compact",
"icon": "example",
"trend": {
"customPeriodEnd": "example",
"customPeriodStart": "example",
"format": "absolute",
"isShown": false,
"period": "custom",
"positiveDirection": "down"
}
},
"displayAs": "example",
"expression": "example",
"fieldIdDataPoint": "conditional",
"fieldIdValue": "example",
"fieldName": "example",
"filter": [],
"flex": "example",
"ganttConfig": {
"baselineEndFieldName": "example",
"baselineStartFieldName": "example",
"dependencyDirection": "predecessor",
"dependencyFieldName": "example",
"disableDragAndDrop": false,
"endFieldName": "example",
"hideTitleColumn": false,
"hideWeekends": false,
"milestoneFieldName": "example",
"progressFieldName": "example",
"showCriticalPath": false,
"showWeekends": false,
"startFieldName": "example",
"timeScale": "day",
"titleColumnFieldName": "example",
"titleColumnWidth": 1.0
},
"gap": "example",
"globalFilterBinding": [],
"gridPreset": "example",
"groupByFieldName": "example",
"height": 1.0,
"icon": {
"color": "example",
"filling": 0,
"icon": "example"
},
"iconLeft": {
"color": "example",
"filling": 0,
"icon": "example"
},
"iconRight": {
"color": "example",
"filling": 0,
"icon": "example"
},
"id": "example",
"imagePosition": {
"position": "example",
"size": "example"
},
"isCompact": false,
"isHidden": false,
"isMarkdownEnabled": false,
"isSpreadsheetMode": false,
"kind": "example",
"labelPosition": "example",
"labels": {},
"mapTypeId": "example",
"margin": "example",
"name": "example",
"onChange": "example",
"onClick": "example",
"order": 1.0,
"overflow": "example",
"padding": "example",
"parentId": "example",
"placeholder": {},
"quickStyle": "body-md",
"radius": "example",
"remember": "localStorage",
"shadow": "example",
"shadowDom": false,
"showAs": "example",
"showBulkActions": false,
"showCalendarType": false,
"showCreateButton": false,
"showCreateRow": false,
"showDataAs": "example",
"showEmptyLane": false,
"showLinkExistingRecord": false,
"showMetadata": false,
"showOutlines": false,
"showSearchField": false,
"showTimeScaleSelector": false,
"showTitle": false,
"size": "example",
"tableName": "example",
"textAlign": "text-center",
"titleFieldName": "example",
"tooltip": "example",
"type": "example",
"value": "example",
"valueSpec": {
"type": "example"
},
"valueType": "example",
"variant": "example",
"view": {
"columns": [],
"conditionalFormatting": [],
"filter": [],
"groupBy": [],
"sort": {
"direction": "asc",
"fieldName": "example"
}
},
"visible": false,
"visibleRoles": [],
"widgetName": "example",
"widgetProps": {},
"width": 1.0
}
},
"has_more": false,
"next_cursor": null
}Get field
Get field. Returns one response page; the connected account determines access.
Inputs
- FieldName
fieldNametextRequired - Field name
- ModuleName
moduleNametextRequired - Module name
- TableName
tableNametextRequired - Table name
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"data": {
"binding": "example",
"canRead": "example",
"canWrite": "example",
"defaultValue": {
"$nx": "example"
},
"expression": "example",
"index": false,
"isAnniversary": false,
"labels": {},
"name": "example",
"onUpdate": "example",
"optionColor": "example",
"optionIcon": "example",
"optionName": "example",
"options": [],
"readRoles": [],
"refTableName": "example",
"required": false,
"search": false,
"syncedFrom": "example",
"type": "any",
"unique": false,
"variant": "example",
"writeRoles": []
}
},
"has_more": false,
"next_cursor": null
}Get function
Get function. Returns one response page; the connected account determines access.
Inputs
- ModuleName
moduleNametextRequired - Module name
- ScriptName
scriptNametextRequired - Global function script name
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"data": {
"code": "example",
"id": "example",
"moduleName": "example",
"name": "example"
}
},
"has_more": false,
"next_cursor": null
}Get module
Get module. Returns one response page; the connected account determines access.
Inputs
- ModuleName
moduleNametextRequired - Module name
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"data": {
"afterOpen": "example",
"components": [],
"hideNavigation": false,
"icon": {
"color": "example",
"filling": 0,
"icon": "example"
},
"isHidden": false,
"labels": {},
"moduleId": "example",
"name": "example",
"openRoles": [],
"tables": []
}
},
"has_more": false,
"next_cursor": null
}Get module definition
Get module definition. Returns one response page; the connected account determines access.
Inputs
- ModuleName
moduleNametextRequired - Module name
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"data": {
"capabilities": [],
"checksum": "example",
"formatVersion": 1,
"objects": [],
"requiredConnections": [],
"roles": []
}
},
"has_more": false,
"next_cursor": null
}Get record
Get record. Returns one response page; the connected account determines access.
Inputs
- ModuleName
moduleNametextRequired - Module name
- RecordId
recordIdnumberRequired - Record IDFrom 0 to 9007199254740991.
- TableName
tableNametextRequired - Table name
- Fields
fieldslist - Choose fields to include, or enter their names.
- ChoiceStyle
choiceStyletext - Choicestyle.
- DateStyle
dateStyletext - Datestyle.
- Style
styletext - Style.
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"data": {
"id": "example",
"values": {}
}
},
"has_more": false,
"next_cursor": null
}Get report
Get report. Returns one response page; the connected account determines access.
Inputs
- ReportId
reportIdtextRequired - Report ID
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"data": {
"fontFamily": "example",
"fontSize": 1.0,
"footHeight": 1.0,
"headHeight": 1.0,
"id": "example",
"inlineStyle": "example",
"labels": {},
"marginB": 1.0,
"marginL": 1.0,
"marginR": 1.0,
"marginT": 1.0,
"moduleName": "example",
"name": "example",
"objects": [],
"paperHeight": 1.0,
"paperWidth": 1.0,
"printAttachments": false,
"tableName": "example"
}
},
"has_more": false,
"next_cursor": null
}Get table
Get table. Returns one response page; the connected account determines access.
Inputs
- ModuleName
moduleNametextRequired - Module name
- TableName
tableNametextRequired - Table name
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"data": {
"canCreate": "example",
"canDelete": "example",
"canRead": "example",
"canWrite": "example",
"createRoles": [],
"deleteRoles": [],
"fields": [],
"hasFiles": false,
"hasGlobalSearch": false,
"hasHistory": false,
"icon": {
"color": "example",
"filling": 0,
"icon": "example"
},
"isEmailLinkingEnabled": false,
"isHidden": false,
"labels": {},
"name": "example",
"onCreate": "example",
"onDelete": "example",
"onUpdate": "example",
"readRoles": [],
"writeRoles": []
}
},
"has_more": false,
"next_cursor": null
}Get view
Get view. Returns one response page; the connected account determines access.
Inputs
- ViewId
viewIdtextRequired - View ID
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"data": {
"annualRecurring": false,
"calendarType": "day",
"chartConfig": {
"chartType": "bar",
"dataSets": [],
"donut": false,
"labelPosition": "bottom",
"legend": {
"show": false
},
"limit": 1,
"orientation": "horizontal",
"showDataTable": false,
"showLabels": false,
"showPoints": false,
"showTitle": false,
"smooth": false,
"stacked": false,
"style": "default",
"tooltips": {
"show": false
},
"xAxis": {
"fieldName": "example",
"groupBy": "daily",
"show": false
},
"yAxis": {
"show": false
}
},
"columns": [],
"conditionalFormatting": [],
"filter": [],
"ganttConfig": {
"baselineEndFieldName": "example",
"baselineStartFieldName": "example",
"dependencyDirection": "predecessor",
"dependencyFieldName": "example",
"disableDragAndDrop": false,
"endFieldName": "example",
"hideTitleColumn": false,
"hideWeekends": false,
"milestoneFieldName": "example",
"progressFieldName": "example",
"showCriticalPath": false,
"showWeekends": false,
"startFieldName": "example",
"timeScale": "day",
"titleColumnFieldName": "example",
"titleColumnWidth": 1.0
},
"groupBy": [],
"icon": {
"color": "example",
"filling": 0,
"icon": "example"
},
"id": "example",
"labels": {},
"moduleName": "example",
"name": "example",
"order": 1.0,
"pivot": {
"columnWidths": {
"rowHeader": 1.0,
"values": {}
},
"columns": [],
"rows": [],
"values": []
},
"search": "example",
"showCalendarType": false,
"showSearchField": false,
"sort": {
"direction": "asc",
"fieldName": "example"
},
"tableName": "example",
"type": "Calendar"
}
},
"has_more": false,
"next_cursor": null
}Get workspace
Get workspace. Returns one response page; the connected account determines access.
Inputs
None.
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"data": {
"modules": [],
"name": "example"
}
},
"has_more": false,
"next_cursor": null
}List fields
List fields. Returns one response page; the connected account determines access.
Inputs
- ModuleName
moduleNametextRequired - Module name
- TableName
tableNametextRequired - Table name
- Limit
limitnumber - Maximum number of fields to returnAt least 1.
- Offset
offsetnumber - Number of fields to skip (starts with 0)At least 0.
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"data": [],
"page_info": {
"has_more": false,
"limit": 1.0,
"offset": 1.0
}
},
"has_more": false,
"next_cursor": null
}List functions
List functions. Returns one response page; the connected account determines access.
Inputs
- ModuleName
moduleNametextRequired - Module name
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"data": []
},
"has_more": false,
"next_cursor": null
}List modules
List modules. Returns one response page; the connected account determines access.
Inputs
- Limit
limitnumber - Maximum number of modules to returnAt least 1.
- Offset
offsetnumber - Number of modules to skip (starts with 0)At least 0.
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"data": [],
"page_info": {
"has_more": false,
"limit": 1.0,
"offset": 1.0
}
},
"has_more": false,
"next_cursor": null
}List record changes
List record changes. Returns one response page; the connected account determines access.
Inputs
- ModuleName
moduleNametextRequired - Module name
- TableName
tableNametextRequired - Table name
- AsOf
asOfdate and time - 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
- Limit
limitnumber - Maximum number of changes to return (1-100)From 1 to 100.
- Offset
offsetnumber - Number of changes to skip (starts with 0)At least 0.
- SinceSeq
sinceSeqtext - Sinceseq.
- SinceSq
sinceSqtext - Sincesq.
- Since
sincedate and timeRequired - Return changes at or after this ISO 8601 timestamp
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"data": [],
"meta": {
"asOf": "example"
},
"page_info": {
"has_more": false,
"limit": 1.0,
"offset": 1.0
}
},
"has_more": false,
"next_cursor": null
}List records
List records. Returns one response page; the connected account determines access.
Inputs
- ModuleName
moduleNametextRequired - Module name
- TableName
tableNametextRequired - Table name
- Fields
fieldslist - Choose fields to include, or enter their names.
- Filter
filterobject - Field names and matching values. Converted to the JSON filter expected by Ninox.
- Limit
limitnumber - Maximum number of rows to return (1-100)From 1 to 100.
- Offset
offsetnumber - Number of rows to skip (starts with 0)At least 0.
- ChoiceStyle
choiceStyletext - Choicestyle.
- DateStyle
dateStyletext - Datestyle.
- Style
styletext - Style.
- Sort
sorttext - Comma-separated field names to sort by; prefix a field with "-" for descending, e.g. sort=name,-_md
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"data": [],
"meta": {
"filter": {},
"sort": "example"
},
"page_info": {
"has_more": false,
"limit": 1.0,
"offset": 1.0
}
},
"has_more": false,
"next_cursor": null
}List reports
List reports. Returns one response page; the connected account determines access.
Inputs
- ModuleName
moduleNametextRequired - Module name
- TableName
tableNametextRequired - Table name
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"data": []
},
"has_more": false,
"next_cursor": null
}List schema changes
List schema changes. Returns one response page; the connected account determines access.
Inputs
- AsOf
asOfdate and time - 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
- Limit
limitnumber - Maximum number of changes to return (1-100)From 1 to 100.
- Offset
offsetnumber - Number of changes to skip (starts with 0)From 0 to 9007199254740991.
- SinceSeq
sinceSeqtext - Sinceseq.
- SinceSq
sinceSqtext - Sincesq.
- Since
sincedate and timeRequired - Return changes at or after this ISO 8601 timestamp
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"data": [],
"meta": {
"asOf": "example",
"retentionCutoff": "example"
},
"page_info": {
"has_more": false,
"limit": 1.0,
"offset": 1.0
}
},
"has_more": false,
"next_cursor": null
}List tables
List tables. Returns one response page; the connected account determines access.
Inputs
- ModuleName
moduleNametextRequired - Module name
- Limit
limitnumber - Maximum number of tables to returnAt least 1.
- Offset
offsetnumber - Number of tables to skip (starts with 0)At least 0.
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"data": [],
"page_info": {
"has_more": false,
"limit": 1.0,
"offset": 1.0
}
},
"has_more": false,
"next_cursor": null
}List views
List views. Returns one response page; the connected account determines access.
Inputs
- ModuleName
moduleNametextRequired - Module name
- TableName
tableNametextRequired - Table name
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"data": []
},
"has_more": false,
"next_cursor": null
}Update records
Update records. Returns one response page; the connected account determines access.
Inputs
- ModuleName
moduleNametextRequired - Module name
- TableName
tableNametextRequired - Table name
- Records
recordslistRequired - Array of records to update (each must include an id field as a positive integer)
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"data": {
"updatedIds": []
}
},
"has_more": false,
"next_cursor": null
}Upsert records
Upsert records. Returns one response page; the connected account determines access.
Inputs
- ModuleName
moduleNametextRequired - Module name
- TableName
tableNametextRequired - Table name
- MatchField
matchFieldtextRequired - Name of the unique field used to match existing records
- Records
recordslistRequired - Array of records to upsert : each must include a value for matchField
Outputs
API response.
dataobject- Data.
has_moretrue/false- Whether a continuation page is available.
next_cursortext- Continuation value, when supplied by the service.
Example output
{
"data": {
"data": {
"createdIds": [],
"updatedIds": []
}
},
"has_more": false,
"next_cursor": null
}