Public Cloud APIs
All available Ninox Public Cloud API endpoints
Content in curly brackets { }
signifies a placeholder. Both the curly brackets and the content within must be replaced for the request to work.
Get multiple workspaces
GET
https://api.ninox.com/v1/teams
Retrieves data from multiple teams
Headers
Authorization*
string
Bearer {accessToken}
Content-Type
string
application/json
Sample request
Get a single workspace
GET
https://api.ninox.com/v1/teams/{teamid}
Retrieves data from a single team
Path Parameters
teamid*
string
workspace id
Headers
Authorization*
string
Bearer {accessToken}
Content-Type
string
application/json
Sample request
Get multiple databases
GET
https://api.ninox.com/v1/teams/{teamid}/databases
Retrieves data from multiple databases
Path Parameters
teamid*
string
workspace id
Headers
Authorization*
string
Bearer {accessToken}
Content-Type
string
application/json
Sample request
Get a schema for a single database
GET
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}
Retrieves data from a schema for a single database
Path Parameters
teamid*
string
workspace id
dbid*
string
database id
Headers
Authorization*
string
Bearer {accessToken}
Content-Type
string
application/json
Sample request
Execute a read-only query with GET
GET
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/{query}
Executes a read-only query in a database
Path Parameters
teamid*
string
workspace id
dbid*
string
database id
Query Parameters
query*
string
string of a query | e.g., (select Contact).'First Name'
Headers
Authorization*
string
Bearer {accessToken}
Content-Type
string
application/json
Sample request
Execute a read-only query with POST
POST
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/{query}
Executes a read-only query in a database
Path Parameters
teamid*
string
workspace id
dbid*
string
database id
Headers
Authorization*
string
Bearer {accessToken}
Content-Type
string
application/json
Request Body
query*
string
string of a query | e.g., (select Contact).'First Name'
Sample request
Execute a writable query
POST
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/exec
Executes a writable query in a database
Path Parameters
teamid*
string
workspace id
dbid*
string
database id
Headers
Authorization*
string
Bearer {accessToken}
Content-Type
string
application/json
Request Body
query*
string
string of a query | e.g., users()
Sample request
Get a schema for multiple tables
GET
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/tables
Retrieves data from a schema for multiple tables
Path Parameters
teamid*
string
workspace id
dbid*
string
database id
Headers
Authorization*
string
Bearer {accessToken}
Content-Type
string
application/json
Sample request
Get a schema for a single table
GET
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/tables/{tid}
Retrieves data from a schema for a single table
Path Parameters
teamid*
string
workspace id
dbid*
string
database id
tid*
string
table id
Headers
Authorization*
string
Bearer {accessToken}
Content-Type
string
application/json
Sample request
Get multiple records
GET
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records
Retrieves data from multiple records in a table
Path Parameters
teamid*
string
workspace id
dbid*
string
database id
tid*
string
table id
Query Parameters
choiceStyle
string
ids | names
choice
string
ids | names
Headers
Authorization*
string
Bearer {accessToken}
Content-Type
string
application/json
Sample request
Get a single record
GET
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}
Retrieves data from a single record in a table
Path Parameters
teamid*
string
workspace id
dbid*
string
database id
tid*
string
table id
rid*
string
record id
Query Parameters
choiceStyle
string
ids | names
style
string
ids | names
Headers
Authorization*
string
Bearer {accessToken}
Content-Type
string
application/json
Sample request
Update a single record with PUT
PUT
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}
Updates a single record in a table
Path Parameters
teamid*
string
workspace id
dbid*
string
database id
tid*
string
table id
rid*
string
record id
Headers
Authorization*
string
Bearer {accessToken}
Content-Type
string
application/json
Request Body
fields
object
object of a field | e.g., "First name": "Jane"
Sample request
Look up/search a single record with GET
GET
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records
Looks up/searches a single record in a table
Path Parameters
teamid
string
workspace id
dbid
string
database id
tid
string
table id
Query Parameters
filters
object
object of filters | e.g., "L": "Stanley"
Headers
Authorizaton
string
Bearer {accessToken}
Content-Type
string
application/json
To look up a record with GET
, make sure the endpoint is/records
. The result will be the same as in Look up/search a single record with POST
(see below).
To identify which filters are mapped to which ids, send a GET
request to retrieve the schema of a single table.
Sample request
Alternative notation
An alternative notation of the example sample request above is to include the parameter filters
in the URL and leave D
(data) empty.
Look up/search a single record with POST
POST
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/record
Looks up/searches a single record in a table
Path Parameters
teamid*
string
workspace id
dbid*
string
database id
tid*
string
table id
Query Parameters
style
string
ids | names
dateStyle
string
ids | names
choiceStyle
string
ids | names
Headers
Authorization*
string
Bearer {accessToken}
Content-Type
string
application/json
Request Body
filters
object
object of filters | e.g., "A": "Sophie"
The endpoint is /record
, not /records
.
To identify which filters are mapped to which ids, send a GET
request to retrieve the schema of a single table.
Sample request
Alternative notation
An alternative notation of the example sample request above is to include the parameter filters
in the URL and leave D
(data) empty.
Create/update multiple records with POST
POST
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records
Creates/updates multiple records in a table
Path Parameters
teamid*
string
workspace id
dbid*
string
database id
tid*
string
table id
Headers
Authorization*
string
Bearer {accessToken}
Content-Type
string
application/json
Request Body
fields, rid
array
array of fields and record ids | e.g.,
"1"
"First name": "Tom"
"First name": "Andrea"
Sample request
To update an existing record, specify a record id and the fields you wish to update in a record.
To create a new record, do not specify the record id, only specify the fields you wish to create in a record.
Upsert (update/insert) multiple records with POST
POST
https://api.ninox.com/v1/teams/{tid}/databases/{dbid}/tables/{tid}/records
Updates records if they exist or inserts new records in a table
Path Parameters
teamid*
string
workspace id
dbid*
string
database id
tid*
string
table id
Headers
Authorization*
string
Bearer {accessToken}
Content-Type
string
application/json
Request Body
_upsert
boolean
true | "_upsert": true
fields, rid*
array
array of fields and record ids | e.g.,
"_id": 43,
"E": "Alfred",
"G": "Becker"
Sample request
Use the upsert
database operation when you need to update a single record or multiple records of the same record ID. This is especially useful when multiple tables are related to each other.
For example, upsert
allows you to sync changes between multiple tables while maintaining the record IDs:
Get changes in a table with sequence number from a source table.
Apply those changes to a target table with Upsert (update/insert) multiple records with POST.
Get changes in a database with sequence number
GET
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/changes?sinceSq={sequence}
Retrieves changes in a database starting with a specified sequence number
Path Parameters
teamid*
string
workspace id
dbid*
string
database id
Query Parameters
sinceSq={sequence}*
integer
changes since sequence number | e.g., sinceSq=1
Headers
Authorization*
string
Bearer {accessToken}
Content-Type
string
application/json
Sample request
Get changes in a table with sequence number
GET
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/changes?sinceSq={sequence}
Retrieves changes in a table starting with a specified sequence number
Path Parameters
teamid*
string
workspace id
dbid*
string
database id
tid*
string
table id
Query Parameters
sinceSq={sequence}*
integer
changes since sequence number | e.g., sinceSq=1
Headers
Authorization*
string
Bearer {accessToken}
Content-Type
string
application/json
Sample request
Get changes in a single record with sequence number
GET
api.ninox.com/v1/teams/{teamid}/databases/(dbid}/tables/{tid}/records/{rid}/changes?sinceSq={sequence}
Retrieves changes in a single record starting with a specified sequence number
Path Parameters
teamid*
string
workspace id
dbid*
string
database id
tid*
string
table id
rid*
string
record id
Query Parameters
sinceSq={sequence}*
integer
changes since sequence number | e.g., sinceSq=1
Headers
Authorization*
string
Bearer {accessToken}
Content-Type
string
application/json
Sample request
Delete a single record
DELETE
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}
Deletes a single record from a table
Path Parameters
teamid*
string
workspace id
dbid*
string
database id
tid*
string
table id
rid*
string
record id
Headers
Authorization*
string
Bearer {accessToken}
Content-Type
string
application/json
Sample request
Delete multiple records
DELETE
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records
Deletes multiple records from a table
Path Parameters
teamid*
string
workspace id
dbid*
string
database id
tid*
string
table id
Headers
Authorization*
string
Bearer {accessToken}
Content-Type
string
application/json
Request Body
record ids*
array
array of record ids
Sample request
Get a single file
GET
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}/files/{file}
Retrieves a single file from a record
Path Parameters
teamid
string
workspace id
dbid
string
database id
tid
string
table id
rid
string
record id
file
string
file name
Headers
Authorization
string
Bearer {accessToken}
Content-Type
string
application/json
Sample request
Upload a single file with POST
POST
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}/files
Uploads a single file to a record
Path Parameters
teamid*
string
workspace id
dbid*
string
database id
tid*
string
table id
rid*
string
record id
Headers
Authorization*
string
Bearer {accessToken}
Content-Type
string
multipart/form-data
Request Body
file*
object
object of a file as multipart/form-data
Sample request
Delete a single file
DELETE
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}/files/{file}
Deletes a single file in a record from a record
Path Parameters
teamid*
string
workspace id
dbid*
string
database id
tid*
string
table id
rid*
string
record id
file*
string
file name
Headers
Authorization*
string
Bearer {accessToken}
Content-Type
string
application/json
Sample request
Get metadata for multiple files
GET
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}/files
Retrieves metadata for multiple files from a record
Path Parameters
teamid*
string
workspace id
dbid*
string
database id
tid*
string
table id
rid*
string
record id
Headers
Authorization*
string
Bearer {accessToken}
Content-Type
string
application/json
Sample request
Get metadata for a single file
GET
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}/files/{file}/metadata
Retrieves metadata for a single file from a record
Path Parameters
teamid*
string
workspace id
dbid*
string
database id
tid*
string
table id
rid*
string
record id
file*
string
file name
Headers
Authorization*
string
Bearer {accessToken}
Content-Type
string
application/json
Sample request
Get a thumbnail for a single file
GET
https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/tables/{tid}/records/{rid}/files/{file}/thumb.jpg
Retrieves a thumbnail for a single file from a record
Path Parameters
file*
string
file name
teamid*
string
workspace id
dbid*
string
database id
tid*
string
table id
rid*
string
record id
Headers
Authorization*
string
Bearer {accessToken}
Content-Type
string
application/json
Sample request
Last updated