API Reference

Codeless Sync provides a RESTful API for programmatic access to all features. This allows you to integrate CLS into your workflows and applications.

Base URL

https://api.codelesssync.com

Authentication

All API requests require authentication using a Bearer token. Include your API key in the Authorization header:

curl -H "Authorization: Bearer YOUR_API_KEY" \\
  https://api.codelesssync.com/api/configs

Getting Your API Key

1. Log in to your CLS dashboard
2. Go to Settings → API Keys
3. Click Generate New Key
4. Copy and store securely

Response Format

All responses are JSON with this structure:

Success Response

{
  "success": true,
  "data": { ... }
}

Error Response

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Configuration not found"
  }
}

HTTP Status Codes

• 200 - Success
• 201 - Created
• 400 - Bad Request (validation error)
• 401 - Unauthorized (invalid API key)
• 403 - Forbidden (insufficient permissions)
• 404 - Not Found
• 429 - Rate Limit Exceeded
• 500 - Internal Server Error

Rate Limiting

API requests are rate limited based on IP address (same limits for all users):

• General API: 60 requests/minute (all standard endpoints)
• Sensitive Operations: 20 requests/minute (config/sync/billing endpoints)
• Authentication: 10 requests/minute (sign-in, registration, account operations)

Rate limit headers are included in responses:

RateLimit-Limit: 60
RateLimit-Remaining: 55
RateLimit-Reset: 1640000000

Pagination

List endpoints support pagination:

GET /api/configs?page=1&limit=20

Parameters:

• page - Page number (default: 1)
• limit - Items per page (default: 20, max: 100)

Response:

{
  "data": [...],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 45,
    "totalPages": 3
  }
}

Available Endpoints

Configurations

Manage sync configurations programmatically.

Projects

Manage PostgreSQL database connections.

Sync Operations

Trigger syncs and check status.

Example: Trigger a Sync

// Using fetch API
const response = await fetch(
  'https://api.codelesssync.com/api/sync/trigger',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      configId: 'config_123',
    }),
  }
);

const data = await response.json();
console.log('Sync ID:', data.data.syncId);

SDKs

Official SDKs are coming soon for:

• Node.js / TypeScript
• Python
• Go

Need Help?

• Troubleshooting Guide