Skip to main content

API Documentation

Complete reference for the Clapwork API

OpenAPI Spec

Resources

Getting Started

Authentication

The Clapwork API uses API keys for authentication. Include your API key in the Authorization header:

Authorization: Bearer clap_live_your_api_key_here

API Key Prefixes

  • clap_live_* - Production keys
  • clap_test_* - Sandbox keys

Quick Example

curl -X GET "https://api.clapwork.com/api/developers/v1/jobs/" \
  -H "Authorization: Bearer clap_live_xxx" \
  -H "Content-Type: application/json"

Rate Limits

API requests are rate-limited based on your tier. Rate limit headers are included in all responses:

X-RateLimit-Limit: 100

X-RateLimit-Remaining: 95

X-RateLimit-Reset: 1609459200

TierRequests/MinuteDaily Quota
Free10010,000
Basic500100,000
Professional2,0001,000,000
Enterprise10,000Unlimited

Error Handling

The API uses standard HTTP status codes. Error responses include a JSON body with details:

{
  "error": {
    "code": "invalid_api_key",
    "message": "The API key provided is invalid or expired",
    "status": 401
  }
}
200Success
400Bad Request - Invalid parameters
401Unauthorized - Invalid API key
403Forbidden - Insufficient permissions
404Not Found - Resource does not exist
429Too Many Requests - Rate limit exceeded
500Internal Server Error

Jobs

Manage job postings

GET/api/developers/v1/jobs/

List all jobs

jobs:read
GET/api/developers/v1/jobs/{id}/

Get job details

jobs:read
POST/api/developers/v1/jobs/

Create a job

jobs:write
PATCH/api/developers/v1/jobs/{id}/

Update a job

jobs:write
DELETE/api/developers/v1/jobs/{id}/

Delete a job

jobs:write

Webhooks

Webhooks allow you to receive real-time notifications when events occur in Clapwork.

Signature Verification

All webhook deliveries include a signature header for verification:

X-Webhook-Signature: t=1609459200,v1=5257a869e7ecebeda32affa62cdca3fa51cad7e77a0e56ff536d0ce8e108d8bd

Available Events

job.created
job.published
job.closed
contract.created
contract.started
contract.completed
proposal.received
proposal.accepted
payment.completed
payment.failed
milestone.approved
review.received

Need Help?

Our developer support team is here to help you integrate with Clapwork.

    You are offline