API Reference

Complete documentation for the Base0 REST API. Learn how to integrate and build applications with our platform.

Authentication

Learn about API keys and authentication methods

API Endpoints

Browse available API endpoints and methods

Code Examples

View integration examples in multiple languages

API Overview

Everything you need to know

Our API follows REST principles and uses standard HTTP methods. All requests and responses are in JSON format.

RESTful Endpoints
Standard HTTP methods with JSON payloads
Authentication
Bearer token authentication with API keys
Rate Limiting
10,000 requests per minute per API key
Response Formats
JSON responses with consistent schemas
Error Handling
Detailed error messages and status codes
Versioning
API versioning via URL path (/v1/)

Authentication

Base0 uses API keys for authentication. Follow these steps to authenticate your requests.

Get Your API Key

Generate an API key from your dashboard

curl -X POST https://api.base0.app/v1/auth/token   -H "Content-Type: application/json"   -d '{
    "client_id": "YOUR_CLIENT_ID",
    "client_secret": "YOUR_CLIENT_SECRET"
  }'

Include in Requests

Add your API key in the Authorization header

curl -X GET https://api.base0.app/v1/projects   -H "Authorization: Bearer YOUR_API_KEY"

Key Expiration

API keys expire after 30 days for security

# Key expiration response
{
  "error": "invalid_token",
  "message": "API key has expired",
  "expires_at": "2024-03-15T00:00:00Z"
}

API Endpoints

Browse our available API endpoints and their documentation

GET/v1/projects

List all projects

Query Parameters

  • page-number-Page number for pagination
  • limit-number-Number of items per page
POST/v1/projects

Create a new project

Request Body

{
  "name": "string",
  "description": "string",
  "settings": "object"
}

API Reference

Explore our RESTful API endpoints and start integrating with Base0

bash
# Get API token
curl -X POST https://api.base0.app/v1/auth/token \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": "YOUR_CLIENT_ID",
    "client_secret": "YOUR_CLIENT_SECRET"
  }'

Getting Started with the API

Our API uses standard HTTP response codes and JSON for request and response bodies. Make sure to replace YOUR_API_TOKEN with your actual API token in the examples above.

Read full API documentation →

Need help with implementation?

Our developer support team is here to help you succeed with Base0.

Contact SupportGitHub Community