API_FUNCTION.md
July 17, 2025 ยท View on GitHub
API Functions
1. Fetch Records
Retrieve data from a specified Nocodb table.
const records = await getRecords("Shinobi");
2. Create Record
Create a new record in a specified Nocodb table.
const response = await postRecords("Shinobi", {
Title: "sasuke"
}
)
3. Update Record
Update an existing record in a specified Nocodb table.
const response = await updateRecords("Shinobi", {
Title: "naruto",
id: 1
}
)
4. Delete Record
Delete a record from a specified Nocodb table.
const response = await deleteRecords("Shinobi", {
id: 1
}
)
5. Get Table Names
Retrieve the names of all tables in the Nocodb database.
const tableNames = await getTableNames();
6. Add Column
Add a new column to a specified Nocodb table.
const response = await addColumn("Shinobi", {
name: "Age",
type: "Number"
}
)
7. Get Table Metadata
Retrieve metadata for a specified Nocodb table.
const metadata = await getTableMetadata("Shinobi");
8. Delete Column
Delete a column from a specified Nocodb table. Column input is columnId
const response = await deleteColumn("c7uo2ruwc053a3a")
9. List Linked Records
Retrieve list of linked records for a specific Link field and Record ID.
const response = await listLinkedRecords("tableId", "linkFieldId", "recordId", "field1,field2");
10. Create Link Between Records
Link records to a specific Link field and Record ID. Existing links will be unaffected.
const response = await createLink("tableId", "linkFieldId", "recordId", [4, 5, 6]);
11. Delete Link Between Records
Unlink records from a specific Link field and Record ID. Duplicated and non-existent record IDs will be ignored.
const response = await deleteLink("tableId", "linkFieldId", "recordId", [1, 2, 3]);