API Reference

The AttributeHQ REST API provides programmatic access to all platform features.

Base URL

https://api.attributehq.com/v1

Authentication

The API uses two authentication methods:

JWT Token

Obtained via POST /api/v1/auth/signup or POST /api/v1/auth/login. Include in the Authorization header:

Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

API Key

Generated via POST /api/v1/apps/:id/keys. Include in the X-API-Key header:

X-API-Key: ak_your_api_key

For sendBeacon fallback (where headers can’t be set), the API key can also be sent in the request body as _api_key.

Response Format

All endpoints return JSON with this structure:

Success

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

Error

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Human-readable error message",
    "details": { ... }
  }
}

Error Codes

Rate Limiting

Endpoints Overview