API v3 (Current)
v3 is the current recommended API version. It provides full access to projects, extractions, SR360 records, and FHIR-formatted resources.
Endpoints
| Method | Path | Description |
|---|---|---|
GET | /api/v3/projects | List published and accessible projects |
GET | /api/v3/projects/:id | Get full project as FHIR bundle |
GET | /api/v3/citations | List citations for a project |
GET | /api/v3/citations/:id | Get a citation |
GET | /api/v3/key_questions | List key questions |
GET | /api/v3/extractions | List extractions |
GET | /api/v3/extractions/:id | Get extraction as FHIR ArtifactAssessment |
GET | /api/v3/sd_meta_data | List SR360 records |
GET | /api/v3/sd_meta_data/:id | Get SR360 as FHIR EvidenceReport |
GET | /api/v3/extraction_forms_projects | List extraction form templates |
POST | /api/v3/fhir_imports | Import a FHIR bundle |
GET | /api/v3/artifact_assessments | List artifact assessments |
GET | /api/v3/users | Get current user info |
Example: Fetching a Project
GET /api/v3/projects/42
Authorization: Bearer YOUR_API_KEY
Returns a FHIR R4 Bundle containing all project resources.
Example: Importing via FHIR
POST /api/v3/fhir_imports
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
{
"resourceType": "Bundle",
"type": "collection",
"entry": [ ... ]
}
Returns 201 on success with the IDs of created resources.
:::note v4
A minimal v4 API exists (/api/v4/projects) but is limited in scope. Use v3 for all current integrations.
:::