API

API Reference

Programmatic access to your assessment data. All endpoints require authentication and return JSON.

Base URL

https://api.joinfriender.com/v1

All API requests must be made over HTTPS. Requests made over HTTP will be rejected. The API uses standard HTTP response codes and returns JSON-formatted responses.

Rate Limits

API requests are rate-limited to ensure fair usage across all customers:

Standard: 100 requests per minute per API key
Enterprise: 1,000 requests per minute per API key
Rate limit headers are included in every response: X-RateLimit-Remaining, X-RateLimit-Reset

Endpoints

Assessment API

REST

Query assessment status, retrieve reports, and access workflow data programmatically.

Webhooks

Events

Receive real-time notifications when assessment milestones are reached.

Authentication

Auth

API key management, OAuth token exchange, and request signing.

Response Format

All successful responses follow a consistent envelope format:

{
  "data": { ... },
  "meta": {
    "requestId": "req_abc123",
    "timestamp": "2025-01-15T10:30:00Z"
  }
}

Error responses include a machine-readable error code and human-readable message:

{
  "error": {
    "code": "ASSESSMENT_NOT_FOUND",
    "message": "No assessment found with the provided ID.",
    "requestId": "req_abc123"
  }
}

API