API Reference

WorkForYourWorld
REST API v2

Full programmatic access to the WorkForYourWorld platform. All endpoints return JSON. Authentication via Bearer token. Base URL: https://api.workforyourworld.tech/v2

Authentication
Overview
Matches
List MatchesTrigger MatchGet Match
Workforce
List EmployeesGet Skill Graph
Impact
Get Impact ScoreGenerate Report
Sessions
List SessionsCreate Session
AUTHBearer TokenAll endpoints

Include your API key as a Bearer token in the Authorization header of every request.

# Example request header Authorization: Bearer wfyw_live_xxxxxxxxxxxxxxxxxxxxxxxx Content-Type: application/json

API keys are generated from Settings → API Keys in your dashboard. Use wfyw_live_ keys for production and wfyw_test_ keys for development.

GET/matchesList AI matches

Returns a paginated list of AI-generated workforce-to-impact matches for your organization.

ParameterTypeDescription
statusstringFilter by status: pending, active, completed
sdgintegerFilter by SDG number (1–17)
limitintegerResults per page (default: 20, max: 100)
cursorstringPagination cursor from previous response
# Example response { "data": [ { "id": "match_01j8k2...", "employee_id": "emp_9f2a...", "opportunity_id": "opp_cc31...", "score": 0.947, "sdg": 13, "status": "active", "reasoning": "Strong alignment on climate data skills...", "created_at": "2025-03-12T14:22:00Z" } ], "next_cursor": "cur_abc...", "total": 12847 }
POST/matches/triggerRun on-demand match

Trigger an on-demand inference run for a specific employee or team. Returns match results within the platform's guaranteed latency SLA (<50ms inference, <2s API response).

# Request body { "employee_id": "emp_9f2a...", // optional "team_id": "team_44b...", // optional "sdg_filter": [13, 8], // optional "limit": 5 // matches per employee }
GET/impact/scoreGet org impact score

Returns the current real-time composite impact score for your organization, including breakdown by SDG, team, and time period.

{ "score": 94.2, "confidence": 0.97, "delta_7d": +8.3, "breakdown_by_sdg": { "13": 96.1, "8": 91.4, "4": 88.7 }, "updated_at": "2025-03-12T15:00:00Z" }
POST/impact/reportsGenerate impact report

Trigger generation of a full impact report for a specified period. Supports CSRD, GRI, ISSB, and custom formats. Reports are available as PDF or JSON.

{ "period_start": "2025-01-01", "period_end": "2025-03-31", "framework": "CSRD", "format": "pdf" }