Deprecated API v1 Documentation 🗄️ Archived

Legacy API version 1 documentation - no longer maintained

 ⚠️ Banner defined in frontmatter missing.

⚠️ This documentation is for API v1 which was deprecated on December 31, 2023.

Please migrate to API v2 for continued support.

Migration Timeline

• December 31, 2023: API v1 deprecated, v2 released
• June 30, 2024: API v1 sunset - all requests will fail
• Current Status: Archived for reference only

Why We Deprecated v1

API v1 had several limitations:

1. Inconsistent response formats
2. Limited pagination support
3. No webhook functionality
4. Poor error handling
5. Security vulnerabilities

Key Differences from v2

Base URL

# v1 (deprecated)
https://api.example.com/api

# v2 (current)
https://api.example.com/v1

Authentication

v1:

X-Auth-Token: your_token

v2:

Authorization: Bearer your_token

Response Format

v1:

{
  "result": {
    "id": 123,
    "name": "Resource"
  },
  "status": "success"
}

v2:

{
  "data": {
    "id": "res_123",
    "name": "Resource"
  }
}

Legacy Endpoints

Get Resources

GET /api/resources

Response:

{
  "result": [
    {
      "id": 123,
      "name": "Resource 1"
    }
  ],
  "status": "success",
  "count": 1
}

Create Resource

POST /api/resources

Request:

{
  "resource": {
    "name": "New Resource",
    "type": 1
  }
}

Migration Guide

See our complete API v1 to v2 Migration Guide for step-by-step instructions.

Support

API v1 is no longer supported. For assistance with migration, please contact our support team.