API Overview

API Overview

WRRK provides a RESTful API that lets you integrate WRRK with your own applications, automate tasks, and build custom workflows.

Base URL

All API requests are made to:

https://api.wrrk.ai/v1

Authentication

The API uses Bearer token authentication. Include your API token in the Authorization header of every request:

Authorization: Bearer your-api-token-here

Generate API tokens at Settings > API > Tokens. Each token can be scoped to specific permissions (read-only, read-write, admin).

Request Format

• All request bodies must be JSON with Content-Type: application/json.
• Query parameters are used for filtering and pagination.
• Dates are in ISO 8601 format: 2026-03-15T10:30:00Z.

Response Format

All responses return JSON with a consistent structure:

{
  "success": true,
  "data": { ... },
  "meta": {
    "page": 1,
    "per_page": 25,
    "total": 150
  }
}

Error responses include an error code and message:

{
  "success": false,
  "error": {
    "code": "not_found",
    "message": "Contact with ID xyz not found"
  }
}

Rate Limiting

API requests are rate-limited based on your plan:

• Starter: 100 requests/minute
• Professional: 500 requests/minute
• Enterprise: 2,000 requests/minute

Rate limit headers are included in every response:

• X-RateLimit-Limit — Maximum requests per minute.
• X-RateLimit-Remaining — Requests remaining in the current window.
• X-RateLimit-Reset — Unix timestamp when the window resets.

Available Endpoints

SDKs

Official SDKs are available for:

• JavaScript/TypeScript — npm install @wrrk/sdk
• Python — pip install wrrk-sdk

See the SDK documentation for language-specific examples.