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
[
{
"id": "mnPLY6DMsvq9wz4id",
"name": "Public Cloud Test Team"
},
{
"id": "Cf8fqfNeCaAvBrjkS",
"name": "Public Cloud Test Team_1"
}
]
Sample request
curl https://api.ninox.com/v1/teams
-X GET
-H "Authorization": "Bearer c0da1580-1a26-11ec-ba4d-f9d8817e4f95"
-H "Content-Type": "application/json"
Get a single workspace
GET https://api.ninox.com/v1/teams/{teamid}
Retrieves data from a single team
Path Parameters
{
"id": "mnPLY6DMsvq9wz4id",
"name": "My Team 1"
}
Sample request
curl https://api.ninox.com/v1/teams/mnPLY6DMsvq9wz4id
-X GET
-H "Authorization": "Bearer c0da1580-1a26-11ec-ba4d-f9d8817e4f95"
-H "Content-Type": "application/json"
Get multiple databases
GET https://api.ninox.com/v1/teams/{teamid}/databases
Retrieves data from multiple databases
Path Parameters
[
{
"id": "gt5k36w957yt",
"name": "Contacts"
}
]
Sample request
curl https://api.ninox.com/v1/teams/mnPLY6DMsvq9wz4id/databases
-X GET
-H "Authorization": "Bearer c0da1580-1a26-11ec-ba4d-f9d8817e4f95"
-H "Content-Type": "application/json"
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
{
"settings": {
"name": "Contacts",
"icon": "i-db-icon-big i-db i-team",
"color": "#6691FF",
"backgroundClass": "background-file",
"backgroundTimestamp": 1505809647759
},
"schema": {
"seq": 223,
"version": 7,
"nextTypeId": 10,
"types": {
},
"afterOpenBehavior": "restoreNavigation",
"fileSync": "full"
}
}
{
"message": "Database Not Found"
}
Sample request
curl https://api.ninox.com/v1/teams/mnPLY6DMsvq9wz4id/databases/gt5k36w957yt
-X GET
-H "Authorization": "Bearer c0da1580-1a26-11ec-ba4d-f9d8817e4f95"
-H "Content-Type": "application/json"
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
Query Parameters
[
"Tim",
"Chalie",
"John",
"Caroline",
"Sophie",
"Hans",
"Alfred ",
"Nadin"
]
Sample request
curl https://api.ninox.com/v1/teams/mnPLY6DMsvq9wz4id/databases/pt53j1tburs8/query?query=(select Contact).'First Name'
-X GET
-H "Authorization": "Bearer c0da1580-1a26-11ec-ba4d-f9d8817e4f95"
-H "Content-Type": "application/json"
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
Request Body
[
"Tim",
"Chalie",
"John",
"Caroline",
"Sophie",
"Hans",
"Alfred ",
"Nadin"
]
Sample request
curl https://api.ninox.com/v1/teams/mnPLY6DMsvq9wz4id/databases/gt5k36w957yt/query
-X POST
-H "Authorization": "Bearer c0da1580-1a26-11ec-ba4d-f9d8817e4f95"
-H "Content-Type": "application/json"
-D {
"query": "(select Contact).'First Name'"
}
Execute a writable query
POST https://api.ninox.com/v1/teams/{teamid}/databases/{dbid}/exec
Executes a writable query in a database
Path Parameters
Request Body
[
"anm2jMxL7kRuatXW9"
]
Sample request
curl https://api.ninox.com/v1/teams/mnPLY6DMsvq9wz4id/databases/gt5k36w957yt/exec
-X POST
-H "Authorization": "Bearer c0da1580-1a26-11ec-ba4d-f9d8817e4f95"
-H "Content-Type": "application/json"
-D '{
"query": "users()"
}'
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
[
{
"id": "A",
"name": "Contact",
"fields": [
]
},
{
"id": "B",
"name": "Contact Email",
"fields": [
]
},
{
"id": "C",
"name": "Contact Phone",
"fields": [
]
},
{
"id": "D",
"name": "Contact Address",
"fields": [
]
},
{
"id": "E",
"name": "Contact Internet",
"fields": [
]
},
{
"id": "F",
"name": "Contact instant messenger accounts",
"fields": [
]
},
{
"id": "G",
"name": "Contact social profiles",
"fields": [
]
},
{
"id": "H",
"name": "Table1",
"fields": [
]
},
{
"id": "I",
"name": "Table2",
"fields": [
]
}
]
Sample request
curl https://api.ninox.com/v1/teams/mnPLY6DMsvq9wz4id/databases/gt5k36w957yt/tables
-X GET
-H "Authorization": "Bearer c0da1580-1a26-11ec-ba4d-f9d8817e4f95"
-H "Content-Type": "application/json"
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
{
"id": "A",
"name": "Contact",
"fields": [
{
"id": "A",
"name": "Kind",
"type": "choice",
"choices": [
{
"id": "1",
"caption": "Person",
"captions": {}
},
{
"id": "2",
"caption": "Company",
"captions": {}
}
]
}
]
}
Sample request
curl https://api.ninox.com/v1/teams/mnPLY6DMsvq9wz4id/databases/gt5k36w957yt/tables/A
-X GET
-H "Authorization": "Bearer c0da1580-1a26-11ec-ba4d-f9d8817e4f95"
-H "Content-Type": "application/json"
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
Query Parameters
[
{
"id": 1,
"createdAt": "",
"createdBy": 0,
"modifiedAt": "2017-08-01T16:52:12",
"modifiedBy": "EPZ2zSxuC7jt6WF2D",
"fields": {
}
}
{
"id": 4,
"createdAt": "",
"createdBy": "EPZ2zSxuC7jt6WF2D",
"modifiedAt": "2017-08-01T17:06:52",
"modifiedBy": "EPZ2zSxuC7jt6WF2D",
"fields": {
}
}
]
