{ "opencollection": "1.0.0", "info": { "name": "NocoDB Data Attachments Records API", "version": "2.0" }, "request": { "auth": { "type": "apikey", "key": "xc-token", "value": "{{xc-token}}", "placement": "header" } }, "items": [ { "info": { "name": "Records", "type": "folder" }, "items": [ { "info": { "name": "List records", "type": "http" }, "http": { "method": "GET", "url": "https://app.nocodb.com/api/v2/tables/:tableId/records", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Unique identifier of the NocoDB table" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of field names to include in the response" }, { "name": "sort", "value": "", "type": "query", "description": "Sort specification. Prefix field name with '-' for descending order. Multiple sorts can be comma-separated." }, { "name": "where", "value": "", "type": "query", "description": "Filter expression using NocoDB where-clause syntax. Example: (field,eq,value)~and(field2,gt,5)" }, { "name": "offset", "value": "", "type": "query", "description": "Number of rows to skip (for pagination)" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of rows to return per page" }, { "name": "viewId", "value": "", "type": "query", "description": "Optional view identifier to apply view-specific filters" } ], "auth": { "type": "apikey", "key": "xc-token", "value": "{{xc-token}}", "placement": "header" } }, "docs": "List all rows from a NocoDB table. Fields to be included in the response can be refined through query parameters. Additionally, filtering, sorting, and pagination can be applied to the results." }, { "info": { "name": "Create records", "type": "http" }, "http": { "method": "POST", "url": "https://app.nocodb.com/api/v2/tables/:tableId/records", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Unique identifier of the NocoDB table" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "xc-token", "value": "{{xc-token}}", "placement": "header" } }, "docs": "Insert a new row in a table by providing a key-value pair object where the key refers to the column alias. All required fields should be included with the payload, excluding auto-increment and columns with default values." }, { "info": { "name": "Update records", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.nocodb.com/api/v2/tables/:tableId/records", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Unique identifier of the NocoDB table" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "xc-token", "value": "{{xc-token}}", "placement": "header" } }, "docs": "Bulk update rows in a table by providing key-value pair objects. Requires the record's primary key field." }, { "info": { "name": "Delete records", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.nocodb.com/api/v2/tables/:tableId/records", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Unique identifier of the NocoDB table" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "xc-token", "value": "{{xc-token}}", "placement": "header" } }, "docs": "Bulk delete rows from a table." }, { "info": { "name": "Read a record", "type": "http" }, "http": { "method": "GET", "url": "https://app.nocodb.com/api/v2/tables/:tableId/records/:recordId", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Unique identifier of the NocoDB table" }, { "name": "recordId", "value": "", "type": "path", "description": "Primary key value of the record" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of field names to include in the response" } ], "auth": { "type": "apikey", "key": "xc-token", "value": "{{xc-token}}", "placement": "header" } }, "docs": "Read a single row from a table by its primary key." }, { "info": { "name": "Update a record", "type": "http" }, "http": { "method": "PATCH", "url": "https://app.nocodb.com/api/v2/tables/:tableId/records/:recordId", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Unique identifier of the NocoDB table" }, { "name": "recordId", "value": "", "type": "path", "description": "Primary key value of the record" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "xc-token", "value": "{{xc-token}}", "placement": "header" } }, "docs": "Update a single row in a table by its primary key." }, { "info": { "name": "Delete a record", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.nocodb.com/api/v2/tables/:tableId/records/:recordId", "params": [ { "name": "tableId", "value": "", "type": "path", "description": "Unique identifier of the NocoDB table" }, { "name": "recordId", "value": "", "type": "path", "description": "Primary key value of the record" } ], "auth": { "type": "apikey", "key": "xc-token", "value": "{{xc-token}}", "placement": "header" } }, "docs": "Delete a single row from a table by its primary key." } ] } ], "bundled": true }