Introduction

Welcome to the ParseForge API documentation. Our API provides a simple and powerful way to integrate advanced functionality into your applications.

Key Features

• RESTful API design
• JSON request and response format
• HTTP status codes for error handling
• Rate limiting: 1000 requests per hour
• HTTPS encryption for all endpoints

Authentication

All API requests require authentication using an API key. Include your API key in the request header:

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Getting Your API Key

1. Create an account at ParseForge Dashboard
2. Navigate to the API Keys section
3. Click "Generate New Key"
4. Copy and securely store your key

Quick Start

Make your first API call in just a few minutes:

Example Request

curl -X GET https://api.parseforge.dev/v1/users/123 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

const response = await fetch('https://api.parseforge.dev/v1/users/123', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
});
const data = await response.json();
console.log(data);

import requests

url = "https://api.parseforge.dev/v1/users/123"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
}

response = requests.get(url, headers=headers)
print(response.json())

Response

{
  "id": "123",
  "name": "Sample User",
  "email": "user@example.com",
  "created": "2026-02-28T10:00:00Z"
}

Users API

Manage user data with our Users API endpoints.

{
  "email": "john@example.com",
  "name": "John Doe",
  "role": "user"
}

{
  "id": "usr_abc123",
  "email": "john@example.com",
  "name": "John Doe",
  "role": "user",
  "created_at": "2026-03-02T10:30:00Z"
}

{
  "name": "John Smith",
  "role": "admin"
}

Webhooks

Receive real-time notifications when events occur in your account.

Setting Up Webhooks

1. Go to your Dashboard
2. Navigate to Settings → Webhooks
3. Add a webhook endpoint URL
4. Select the events you want to receive

Webhook Payload

{
  "event": "user.created",
  "data": {
    "id": "usr_abc123",
    "email": "john@example.com",
    "name": "John Doe"
  },
  "timestamp": "2026-03-02T10:30:00Z"
}

Event Types

Verifying Webhook Signatures

Each webhook request includes a signature in the X-Webhook-Signature header. Verify this signature to ensure the request came from ParseForge:

const crypto = require('crypto');

const signature = request.headers['x-webhook-signature'];
const payload = JSON.stringify(request.body);
const secret = 'your_webhook_secret';

const expectedSignature = crypto
  .createHmac('sha256', secret)
  .update(payload)
  .digest('hex');

if (signature === expectedSignature) {
  // Valid webhook
}

Error Handling

The API uses standard HTTP response codes to indicate success or failure.

HTTP Status Codes

Error Response Format

{
  "error": {
    "code": "invalid_parameter",
    "message": "The 'email' parameter is required",
    "param": "email",
    "type": "validation_error"
  }
}

Rate Limiting

API requests are subject to rate limits based on your plan:

Rate Limit Headers

Each API response includes rate limit information in the headers:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 987
X-RateLimit-Reset: 1709380800

Pagination

List endpoints return paginated results. Use query parameters to control pagination:

Example Request

GET /api/users?limit=20&offset=40

Paginated Response

{
  "data": [...],
  "pagination": {
    "total": 150,
    "limit": 20,
    "offset": 40,
    "has_more": true
  }
}

API Reference

Detailed documentation for all API endpoints.

{
  "id": "usr_abc123",
  "email": "john@example.com",
  "name": "John Doe",
  "role": "user",
  "created_at": "2026-03-01T10:30:00Z",
  "updated_at": "2026-03-02T14:20:00Z"
}

{
  "name": "Example",
  "value": "Sample data"
}

Client Libraries

Official SDKs to integrate ParseForge into your applications:

npm install parseforge-sdk

pip install parseforge

gem install parseforge

implementation 'com.parseforge:sdk:1.0'