New to Corsair? See API access, authentication, and error handling.
Fields
create
fields.create
Add a field to a table: text, number, choice, date, reference and the other Ninox types
Risk: write
Choice and multi options are [{ label }]; Ninox assigns the ids.
field full type
field full type
field full type
field full type
delete
fields.delete
Delete a field and the value every record held in it
Risk: destructive · Irreversible
Output
list
fields.list
List a table’s field names and types, which decide what a record write may set
Risk: read
Output
fields full type
fields full type
page_info full type
page_info full type
Modules
get
modules.get
Read one module (app) by its internal name
Risk: read
Output
module full type
module full type
list
modules.list
List the workspace’s modules, paged by limit and offset
Risk: read
Output
modules full type
modules full type
page_info full type
page_info full type
Records
changes
records.changes
Poll a table’s row-level change feed since a timestamp, which needs history tracking enabled on that table
Risk: read
Needs history tracking on the table, which otherwise answers 400. Pass result.asOf back as since on the next poll.
Output
changes full type
changes full type
page_info full type
page_info full type
create
records.create
Create rows in one transaction, so a single bad record rolls the whole batch back
Risk: write
Output
delete
records.delete
Delete rows in one transaction, rolling the whole set back if any id is wrong; there is no restore call
Risk: destructive · Irreversible
Output
get
records.get
Read one row by id, which is the only way to fetch a known record because the id is not filterable
Risk: read
Output
list
records.list
Read rows from a table with a field filter, sort order and offset paging; only columns the table marks filterable are accepted
Risk: read
filter is a JSON string, and only columns the table marks filterable are accepted.
Output
rows full type
rows full type
page_info full type
page_info full type
update
records.update
Update rows in one transaction, optionally rejecting a write when a field no longer holds the value the caller read
Risk: write
Put values you read into _expected; a mismatch answers 409 unless override is true.
records full type
records full type
upsert
records.upsert
Create or update rows matched by one unique field, refusing an ambiguous match rather than picking a row
Risk: write
matchField must be a field marked unique; an ambiguous match answers 409 rather than picking a row.
Output
Scripts
execute
scripts.execute
Run Ninox script in a module and return its result; a script can change or delete records
Risk: destructive · Irreversible
A script can write and delete, so this is destructive. A long script, or mode background, answers { run: { id, status } } instead of { result }.
Output
run full type
run full type
Tables
create
tables.create
Create a table in a module; add its fields with fields.create
Risk: write
table full type
table full type
table full type
table full type
delete
tables.delete
Delete a table and every record in it
Risk: destructive · Irreversible
Output
get
tables.get
Read one table with all of its field definitions
Risk: read
Output
table full type
table full type
list
tables.list
List the tables inside one module
Risk: read
Output
tables full type
tables full type
page_info full type
page_info full type
Views
list
views.list
List a table’s saved views
Risk: read
Output
views full type
views full type
Workspace
get
workspace.get
Read the workspace and the modules in it
Risk: read
Output
modules full type
modules full type