The Stackby API is a RESTful API.
\nPlease note: The old versions - betav1 and v0 will be deprecated by June 30th, 2025. Please move to the latest endpoint - v1.
\nIt provides you an easy way to access your stack's data programmatically. You can integrate your stack data with any external system.
\nIt works on REST semantics, uses JSON as an object response and standard HTTP codes to signal operation status.
\nYou can use Stackby API to -
\nList rows from a table
\nBring new row from a viw
\nGet view lists
\nCreate, Update and Delete rows
\nGet specific rows by it's ID
\nUpload files
\nNote: The Stackby API is now live and functioning. As we update and release newer versions of the API, we reserve the right to remove older APIs and functionality with a 4-week deprecation notice.
\nWhile we continue to build this API and give our users and community better leverage to access Stackby data and connect to third party sources, we've also integrated with Zapier, Make.com, Pabbly Connect, Integrately, Albato, SyncSpider, n8n.io and others.
\nIf you have any question, suggestion or use-case to share related to the API, please reach out to us on developers@stackby.com. We really appreciate your feedback.
\nUse this as a {{base_url}} - https://stackby.com/api
\nThe Stackby API is limited to 5 requests per second per stack. If you exceed this rate limit, you will get 429 status code and need to wait for 30 seconds before subsequent requests will go through.
\nStackby uses simple token based authentication system. To generate your API key, please visit your Account settings in Stackby. Please make sure to keep this API key safe, it carries all the information of your user account and it's underlying data.
\nYou have to provide the API key in the HTTP bearer token header by adding a new header key with x-api-key and adding your API key from your Stackby account. You'll then be able to call the data from your stack.
\nAll API requests must be authenticated and made over HTTPS.
\nYou can bring your stack ID and Table ID from the URL of the stack.
\nReturned rows do not bring any 'empty' values from the table. Eg. \" \", [ ] or false.
\nYou can filter, sort, and format the results with the following query parameters.
\nTo use multiple filters, use the following format with and/or:
\ntoContains({Column Name 1},value) and/or toContains({Column Name2}, value)
\n","urlObject":{"path":["v1","rowlist","{{stackId}}","{{tablename}}"],"host":["{{base_url}}"],"query":[{"key":"latest","value":"true"}],"variable":[]}},"response":[],"_postman_id":"c7401df3-f53b-437f-87bf-b3a3ab1fac09"},{"name":"New Row in View","id":"44269b4a-3317-4f74-8d2b-c0ae8c41b6a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"api-key","value":"3eDeFlpAAVVe5OMH","type":"text"}],"url":"{{base_url}}/v1/newrows/stqYn5AvM8wJP1pfjw/tbmtIz6IUXZ1ogNJeB/vw1693302001816506de2?maxRecord=1","description":"New row in View
\nEndpoint: {{base_url}}/v1/newrows/{StackID}/{TableID}/{ViewID}
\nFind {ViewID} From View List API
\nThis is a dynamic URL where {{base_url}} should be replaced with the base URL of the Stackby API, and {StackID}, {TableID}, and {ViewID} should be replaced with specific identifiers corresponding to a Stack, Table, and View in Stackby.
\nBehavior:
\nWhen users access this endpoint with a query parameter maxRecord, they can specify a limit for the number of records returned in the API response.
\nExample 1: maxRecord=5 - This limits the response to a maximum of 5 records.
\nThere's a predefined maximum limit of 15 records when users do not specify a maxRecord value.
\nThis API allows users to interact with Stackby by fetching data from a specific Stack, Table, and View, and they have the flexibility to control the number of records returned using the maxRecord parameter.
\n","urlObject":{"path":["v1","newrows","stqYn5AvM8wJP1pfjw","tbmtIz6IUXZ1ogNJeB","vw1693302001816506de2"],"host":["{{base_url}}"],"query":[{"key":"maxRecord","value":"1"}],"variable":[]}},"response":[],"_postman_id":"44269b4a-3317-4f74-8d2b-c0ae8c41b6a7"},{"name":"Retrieve a Particular Row","id":"cab48a5a-5b89-4b6b-8de9-04d9902f5326","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"api-key","value":"{{apiKey}}"},{"key":"Content-Type","value":"application/json"}],"url":"{{base_url}}/v1/rowlist/{{stackId}}/{{tablename}}?rowIds[]=rw17054017479362efee7","description":"To retrieve an existing row in the table, you can issue a GET request to the specified endpoint.
\nReturned rows do not bring any 'empty' values from the table. Eg. \" \", [ ] or false.
\n","urlObject":{"path":["v1","rowlist","{{stackId}}","{{tablename}}"],"host":["{{base_url}}"],"query":[{"key":"rowIds[]","value":"rw17054017479362efee7"},{"disabled":true,"key":"rowIds[]","value":"rw158108273052769fbf5"},{"disabled":true,"key":"rowIds[]","value":"rw1581082815519928e93y"}],"variable":[]}},"response":[],"_postman_id":"cab48a5a-5b89-4b6b-8de9-04d9902f5326"},{"name":"View List","id":"fab09ace-42b1-4290-88ba-0ab857bc4871","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"api-key","value":"vuOnHILNr16LCJer","type":"text"}],"url":"{{base_url}}/v1/viewlist/stqYn5AvM8wJP1pfjw/tbmtIz6IUXZ1ogNJeB","description":"View list:
\nEndpoint: https://stackby.com/api/v1/viewlist/{stackID}/{tableID}
\nThis is the URL endpoint for Stackby's API.
\nHeaders:
\nHeader Name: api-key
\nThis header is required and should contain your API key for authentication.
\nHeader Name: url
\nThis header should contain the values for stackID and tableID in the format stackID/tableID.
\nWhen making a request to this endpoint, you need to include these headers for authentication and specify the stackID and tableID in the url header to access the specified Stackby stack and table you want to interact with.
\n","urlObject":{"path":["v1","viewlist","stqYn5AvM8wJP1pfjw","tbmtIz6IUXZ1ogNJeB"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fab09ace-42b1-4290-88ba-0ab857bc4871"},{"name":"Create Rows","id":"4a91669b-d19a-4c8f-b15e-482f2649e6ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"{{apiKey}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"records\":[\n\t\t{\n\t\t\t\"field\": {\n\t\t\t\t\"Name\":\"test0505896\",\n\t\t\t\t\"Notes\":\"4\",\n \"Table 2\": \"New Test Row\"\n\t\t\t\t}\n\t\t}\n\t]\n}"},"url":"{{base_url}}/v1/rowcreate/{{stackId}}/{{tablename}}","description":"Endpoint Details:
\n{{base_url}}: Replace this placeholder with the base URL of the Stackby API.
\n{StackID}: Replace this with the identifier of the Stack where the table is located.
\n{Table Name}: Replace this with the name or identifier of the specific table you want to add new rows to.
\nCreating New Rows via POST Request:
\nWhen issuing a POST request to this endpoint, you can create new rows in Stackby.
\n**Request Body:
**
**The request body should consist of an array containing up to 10 row objects. Each row object should have the following properties:
**
field: This property contains all the cell values for that row, organized by column name. You can specify as many column values as needed to populate the new row.
\nCreating a Single Row at the Top:
\nIf you wish to create a single row that is specifically positioned at the top of the table, you can include that row's information in the request body.
\nResponse:
\nUpon a successful creation of the rows, the API will return an array of row objects that uniquely identify the newly created rows.
\n","urlObject":{"path":["v1","rowcreate","{{stackId}}","{{tablename}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4a91669b-d19a-4c8f-b15e-482f2649e6ea"},{"name":"Update rows","id":"b8b7e5ce-5238-4464-8aca-31ff39c9cef2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"api-key","value":"{{apiKey}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\"records\":[{\r\n\"id\": \"rw17054017479362efee7\",\r\n\"field\": {\r\n\t\"Name\":\"Aiyazkhan\",\r\n\t\"Attachments\": \"https://tazlink.com/i/QpPkNa+,https://tazlink.com/i/uQSpSL+\"\r\n\t}\r\n}]\r\n}"},"url":"{{base_url}}/v1/rowupdate/{{stackId}}/{{tablename}}","description":"Endpoint Details:
\n{{base_url}}/api/betav1/rowupdate/{StackID}/{Table Name}
\n{{base_url}}: Replace this placeholder with the base URL of the Stackby API.
\n{StackID}: Replace this with the identifier of the Stack where the table is located.
\n{Table Name}: Replace this with the name or identifier of the specific table you want to update rows in.
\n**Updating Rows via PATCH Request:
**
When issuing a PATCH request to this endpoint, it will update only the fields that you specify. This provides granular control over the updates you want to perform.
\nRequest Body:
\n**The request body should consist of an array containing up to 10 row objects. Each row object should have the following properties:
**
ID: This property represents the rowID of the row you want to update.
\n**field: This property contains all the cell values for that row, organized by column name. You can specify which columns you want to update and provide the new values accordingly.
**
Updating a Single Row at the Top:
\nIf you wish to update a single row specifically positioned at the top of the table, you can include that row's information in the request body.
\nThis document outlines the process for updating rows in Stackby using the PATCH request, specifying the fields you want to modify, and provides guidance on structuring the request body for updates, including updating a single row at the top.
\n","urlObject":{"path":["v1","rowupdate","{{stackId}}","{{tablename}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b8b7e5ce-5238-4464-8aca-31ff39c9cef2"},{"name":"Delete rows","id":"4837d4a4-ecf6-46f0-8de7-e8197f5a8d42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"api-key","value":"{{apiKey}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"records\":[\n\t\t\t\t\t{\n\t\t\t\t\t\t\"id\":\"rw158765476420559bb54\",\n\t\t\t\t\t\t\"field\": {\n\t\t\t\t\t\t\t\"Name\":\"test0505895\",\n\t\t\t\t\t\t\t\"Phone\":\"9999999999\",\n\t\t\t\t\t\t\t\"link\":[\"rw1562824087136c5b34e\"]\n\t\t\t\t\t\t}\n\t\t\t\t\t},\n\t\t\t\t\t{\n\t\t\t\t\t\t\"id\":\"rw15876547642202e2a4e\",\n\t\t\t\t\t\t\"field\": {\n\t\t\t\t\t\t\t\"Name\":\"test05055\",\n\t\t\t\t\t\t\t\"Notes\":\"long text test\",\n\t\t\t\t\t\t\t\"Phone\":\"9999999999\"\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\n\t\t\t\t]\n}"},"url":"{{base_url}}/v1/rowdelete/{{stackId}}/{{tablename}}?rowIds[]=rw15628240845663015b8&rowIds[]=rw158108273052769fbf5&rowIds[]=rw1581082815519928e93","description":"To delete rows for your table, you can issue a DELETE request to the specified endpoint.
\nYou can delete up to 10 rows at a time, please make sure to include a URL encoded array.
\nYou can also delete a single row.
\n","urlObject":{"path":["v1","rowdelete","{{stackId}}","{{tablename}}"],"host":["{{base_url}}"],"query":[{"key":"rowIds[]","value":"rw15628240845663015b8"},{"key":"rowIds[]","value":"rw158108273052769fbf5"},{"key":"rowIds[]","value":"rw1581082815519928e93"}],"variable":[]}},"response":[],"_postman_id":"4837d4a4-ecf6-46f0-8de7-e8197f5a8d42"},{"name":"File Upload","id":"7815ed05-f728-4801-9a4d-ea7760d4cfbf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"wNYy6qWh2MMAFyRz","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"image","type":"file","src":["XvFFOYxaf/IMG-20240812-WA0003.jpg","7ohxz3EeE/download.png"]}]},"url":"{{base_url}}/v1/uploads","description":"If you want to upload a file, then you have to run the file upload API
\nNote: limit per call is max 5 mb.
\n","urlObject":{"path":["v1","uploads"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"8f135e19-99f1-47d0-9969-15851663fa65","name":"File Upload","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"wNYy6qWh2MMAFyRz","type":"text"},{"key":"Content-Type","value":"","type":"text","disabled":true}],"body":{"mode":"formdata","formdata":[{"key":"image","type":"file","src":["XvFFOYxaf/IMG-20240812-WA0003.jpg","7ohxz3EeE/download.png"]}]},"url":"https://stackby.com/api/v1/uploads"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 01 Oct 2024 11:23:46 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.0 (Ubuntu)"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Methods","value":"DELETE,GET,OPTIONS,PATCH,POST,PUT"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, x-api-key, api-key,csrf-token"},{"key":"ETag","value":"W/\"19e-AiwpLXLaL0dMYFuVAk/Zw+YS06k\""},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"container\": \"stackbybucketprod\",\n \"url\": \"https://cdn.filestackcontent.com/OXv8GisSLeS3p1S8vKOQ\",\n \"filename\": \"IMG-20240812-WA0003.jpg\",\n \"key\": \"2LBPTOJNTTaGsoayeebW_IMG-20240812-WA0003.jpg\",\n \"type\": \"image/jpeg\",\n \"size\": 8841\n },\n {\n \"container\": \"stackbybucketprod\",\n \"url\": \"https://cdn.filestackcontent.com/ogqCglClShicD2Jkp8gL\",\n \"filename\": \"download.png\",\n \"key\": \"5tfb4vcCQMuPNpaLHGIJ_download.png\",\n \"type\": \"image/png\",\n \"size\": 4928\n }\n]"}],"_postman_id":"7815ed05-f728-4801-9a4d-ea7760d4cfbf"},{"name":"Column Create","id":"429b18ce-5fb4-4740-8a96-e2c41254aa48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Column Name\",\r\n \"stackId\": \"STACK_ID\",\r\n \"tableId\": \"TABLE_ID\",\r\n \"viewId\": \"VIEW_ID\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/columnCreate/{{type}}","description":"All APIs require a Stackby API Key.
\napi-key: YOUR_API_KEY
\n{
\n\"name\": \"Column Name\",
\n\"stackId\": \"STACK_ID\",
\n\"tableId\": \"TABLE_ID\",
\n\"viewId\": \"VIEW_ID\"
\n}
\nstackId → From Stack List API
\ntableId → From Table List API
\nviewId → From View List API
\nbody: {
\n\"options\": [\"Option A\", \"Option B\", \"Option C\"]
\n}
\nbody: {
\n\"options\": [\"Option A\", \"Option B\", \"Option C\"]
\n}
\nbody: {
\n\"isTimeInclude\": true,
\n\"timeFormat\": \"24\"
\n}
Note: timeFormat values: \"12\" or \"24\"
body: {
\n\"name\": \"Linked Table\",
\n\"stackId\": \"STACK_ID\",
\n\"tableId\": \"CURRENT_TABLE_ID\",
\n\"viewId\": \"VIEW_ID\",
\n\"linkToTableId\": \"FOREIGN_TABLE_ID\",
\n\"linkToTableViewId\": \"FOREIGN_VIEW_ID\"
\n}
\nbody: {
\n\"name\": \"Lookup Column\",
\n\"stackId\": \"STACK_ID\",
\n\"tableId\": \"TABLE_ID\",
\n\"viewId\": \"VIEW_ID\",
\n\"linkToTableId\": \"FOREIGN_TABLE_ID\",
\n\"linkColumnId\": \"LINK_COLUMN_ID\",
\n\"linkedColumnId\": \"FOREIGN_COLUMN_ID\"
\n}
\nbody: {
\n\"name\": \"Lookup Count\",
\n\"stackId\": \"STACK_ID\",
\n\"tableId\": \"TABLE_ID\",
\n\"viewId\": \"VIEW_ID\",
\n\"linkColumnId\": \"LINK_COLUMN_ID\",
\n\"linkToTableId\": \"FOREIGN_TABLE_ID\"
\n}
\nbody: {
\n\"name\": \"Aggregation Column\",
\n\"stackId\": \"STACK_ID\",
\n\"tableId\": \"TABLE_ID\",
\n\"viewId\": \"VIEW_ID\",
\n\"linkColumnId\": \"LINK_COLUMN_ID\",
\n\"linkToTableId\": \"FOREIGN_TABLE_ID\",
\n\"linkedColumnId\": \"FOREIGN_COLUMN_ID\",
\n\"linkToTableViewId\": \"FOREIGN_VIEW_ID\"
\n}
\n","urlObject":{"path":["api","v1","columnCreate","{{type}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"429b18ce-5fb4-4740-8a96-e2c41254aa48"},{"name":"Column list","id":"45ee61ff-32fa-458a-86a9-947386a21269","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_url}}/api/v1/columnList/{{stackId}}/{{tableId}}","description":"api-key: YOUR_API_KEY
\nContent-Type: application/json
\nMethod: GET
Endpoint: {{base_url}}/api/v1/columnList/{{stackId}}/{{tableId}}
api-key: YOUR_API_KEY
\nContent-Type: application/json
\nMethod: DELETE
Endpoint: {{base_url}}/api/v1/columnDelete/{{stackId}}
Request body
{
\"tableId\": \"TABLE_ID\",
\n\"viewId\": \"VIEW_ID\",
\n\"columnId\": \"COLUMN_ID\"
\n}
\n","urlObject":{"path":["api","v1","columnDelete","{{stackId}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"49172f3b-8473-4b1e-b654-082ac6cf99eb"},{"name":"Stack create","id":"d146570d-88b5-4ac6-bc38-334b49b0db2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"My Stack\",\r\n \"color\": \"#4F46E5\",\r\n \"icon\": \"📊\",\r\n \"workspaceId\": \"WORKSPACE_ID\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/api/v1/stack/create","description":"These API allow developers to create Stacks in Stackby.
\nCreates a new stack inside a workspace.
\napi-key: YOUR_API_KEY
\nContent-Type: application/json
\nMethod: POST
Endpoint: {{base_url}}/api/v1/stack/create
{
\n\"name\": \"My Stack\",
\n\"color\": \"#4F46E5\",
\n\"icon\": \"📊\",
\n\"workspaceId\": \"WORKSPACE_ID\"
\n}
\napi-key: YOUR_API_KEY
\nContent-Type: application/json
\nMethod: POST
Endpoint: {{base_url}}/api/v1/stackList
{
\n\"workspaceId\": \"WORKSPACE_ID\"
\n}
\n","urlObject":{"path":["api","v1","stackList"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"873bb75c-52ca-4d9b-b57b-06469a4d8378"},{"name":"Stack delete","id":"1fe14f60-c2a5-4532-9d3f-035cd0d65093","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{base_url}}/api/v1/stackDelete/{{stackId}}","description":"api-key: YOUR_API_KEY
\nContent-Type: application/json
\nMethod: POST
Endpoint: {{base_url}}/api/v1/stackDelete/{{stackId}}
api-key: YOUR_API_KEY
\nContent-Type: application/json
\nMethod: POST
Endpoint: {{base_url}}/api/v1/tableCreate/{{stackId}}
{
\n\"name\": \"Tasks\",
\n\"type\": \"default\",
\n\"data\": \"\",
\n\"copyTableData\": false,
\n\"copyTable\": false
\n}
\nField Description
\n","urlObject":{"path":["api","v1","tableCreate","{stackId}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2e9cb78b-01e8-4b16-9d57-28598b0e0af7"},{"name":"Table list","id":"191b3c0a-04c5-4cb3-9212-e4b730bf5684","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"api-key","value":"{{api-key}}","type":"text"}],"url":"{{base_url}}/api/v1/tableList/{{stackId}}","description":"api-key: YOUR_API_KEY
\nContent-Type: application/json
\nMethod: GET
Endpoint: {{base_url}}/api/v1/tableList/{{stackId}}
api-key: YOUR_API_KEY
\nContent-Type: application/json
\nMethod: DELETE
Endpoint: {{base_url}}/api/v1/tableDelete/{{stackId}}/{{tableId}}