Rest Api Overview

Tadabase REST API Overview

🚀 Try the Interactive API Tester

Test API endpoints directly from your browser with our built-in API testing tool - no Postman installation required!

Features: Save credentials, test endpoints, view responses, export as Postman collection

What is the Tadabase REST API?

The Tadabase REST API allows you to programmatically interact with your Tadabase applications from external systems, scripts, or applications. With the API, you can:

Create, read, update, and delete records in your data tables
Filter and search records with complex conditions
Authenticate users and manage sessions
Trigger tasks and automations
Generate PDFs and export data
Access pages and components
And much more!

API Versions

Tadabase supports multiple API versions to provide different levels of functionality:

Version	Base URL	Purpose
API v1.0	`https://api.tadabase.io/api/v1`	Core data operations (CRUD, tables, fields, tasks, etc.)
API v1.1	`https://api.tadabase.io/api/v1.1/{appId}`	Enhanced features including user authentication, pages, components, imports, exports, and PDFs

Which Version Should I Use?

Use API v1.0 for standard data operations like creating records, filtering, and running tasks. Use API v1.1 when you need user authentication features, page components, or advanced import/export capabilities.

RESTful Design

The Tadabase API follows REST (Representational State Transfer) principles:

Resources: Data tables, records, users, pages, etc. are accessed via URLs
HTTP Methods: Standard methods like GET (read), POST (create), PUT/PATCH (update), DELETE (remove)
JSON Format: Request and response data is sent as JSON
Stateless: Each request contains all necessary authentication and context
Status Codes: Standard HTTP status codes indicate success or error

What You'll Need

To use the Tadabase REST API, you'll need:

A Tadabase Application: The app you want to interact with via API
API Credentials: App ID, App Key, and App Secret (generated in your app settings)
HTTP Client: A tool like Postman, curl, or code in your preferred programming language
Basic Knowledge: Understanding of HTTP, REST APIs, and JSON format

Common Use Cases

Integration with External Systems

Connect Tadabase with other platforms like CRMs, payment processors, marketing tools, or custom applications.

Automation and Workflows

Build automated workflows that trigger actions in Tadabase based on external events, or vice versa.

Mobile Applications

Create custom mobile apps that interact with your Tadabase data using the API.

Data Synchronization

Keep data synchronized between Tadabase and other systems in real-time or on a scheduled basis.

Reporting and Analytics

Pull data from Tadabase into business intelligence tools or custom reporting systems.

Bulk Operations

Perform large-scale data imports, updates, or transformations programmatically.

API Documentation Structure

Our REST API documentation is organized into logical sections:

📚 Documentation Guide

Getting Started: Learn how to set up and make your first API call

Core Operations: Master working with records, filtering, and field types

Intermediate Features: Explore batch operations, user auth, tasks, and imports

Advanced Features: Dive into pages API, PDFs, and webhooks

Best Practices: Understand rate limiting, error handling, and security

Need Help?

API Tester: Use our built-in API Tester to experiment with endpoints
Support: Contact Tadabase support with specific API questions
Community: Visit our community forum to connect with other developers
Examples: Check out code examples throughout the documentation

Next Steps

Ready to get started? Continue to the next article:

→ Getting Your API Keys and Setup

This guide will walk you through generating API credentials and understanding the required headers for all requests.

How did we do ?

Getting Api Keys