How to use API_PurgeRecords in Quickbase
Quickbase API
API_PurgeRecords gives users the ability to batch delete records from Quickbase. This guide teaches how to purge records in mass and alternatives to deletion.
API_PurgeRecords is a Quickbase API function that allows you to delete multiple records at once. This can include:
Child records tied to a parent record
Records from a filtered report
Entire tables (if configured incorrectly)
**Please note: **If you only need to delete a single record, use API_DeleteRecord instead.
Best Practice to Avoid Permanent Deletions in Quickbase
Before using API_PurgeRecords, consider safer alternatives:
Archive records instead of deleting
Update statuses to remove visibility
Apply role-based filters
Deleting data is permanent and irreversible, so please use this API cautiously.
Common Use Cases for API_PurgeRecords
You might use this API when:
Removing test or dummy data
Deleting child records when a parent is canceled
Cleaning up temporary or outdated data (weekly/monthly)
Quickbase API_PurgeRecords URL Structure
Image: What is API_PurgeRecords Mean in Quickbase | Quandary Consulting Group
Key Parameters:
a=API_PurgeRecords → Defines the API action
qid= → Targets a saved report
query= → Custom filter logic
ticket / apptoken → Authentication
Methods to Define Records for Deletion in Quickbase
1. Using qid (Our topic recommendation)
Targets a saved report with predefined filters, a best example of this is**: **https://quandarycg.com/db/tasks_table?a=API_PurgeRecords&qid=45
Best for:
Admin-controlled cleanup
Reusable deletion logic
Safer, pre-tested filters
Avoid using qname — report names can change and break your API.
**2. Using a Custom ****query**
Allows dynamic filtering based on field values. A best example of this is: Delete all tasks for a specific project
query={'99'.EX.'150'}
Full URL: https://quandarycg.com/db/tasks_table?a=API_PurgeRecords&query={'99'.EX.'150'}
Use case:
Deleting child records tied to a parent record
Dynamic record targeting
3. Dynamic Query in a Formula Field
"https://quandarycg.com/db/tasks_table?a=API_PurgeRecords&query={'99'.EX.'" & [Record ID#] & "'}"
Automatically targets the current record context
Critical Warning: If you run API_PurgeRecords with:
An empty
qidAn invalid
query
All records in the table may be deleted permanently.
For more information about developing in Quickbase or to see our How-To Guide about Quickbase API_DeleteRecord, please visit our Quickbase Knowledge Center.
Author: Logan Lott
Title: Solution Consultant | Quickbase
Email: llott@quandarycg.com
Date Published: 06/01/2026
**Top FAQs about Quickbase API_PurgeRecords **
1. How do you delete multiple records in Quickbase?
Use the API_PurgeRecords endpoint with either a qid (saved report) or a query parameter to define which records to delete.
2. Is API_PurgeRecords safe to use?
It is safe only when properly tested. Always validate your query or report before running it in production, as deletions are permanent.
3. What is the best way to remove data in Quickbase?
Instead of deleting, it’s recommended to:
Archive records
Change visibility via roles
Update statuses
4. What’s the difference between API_PurgeRecords and API_DeleteRecord?
API_DeleteRecord → Deletes one record
API_PurgeRecords → Deletes multiple records in bulk
**5. Best advice for when you use API_PurgeRecords? **
API_PurgeRecords is powerful but risky. Always make to sure to:
Test your query/report
Avoid using it unless necessary
Prefer archiving over deleting