Skip to main content

API v3 (Current)

v3 is the current recommended API version. It provides full access to projects, extractions, SR360 records, and FHIR-formatted resources.

Endpoints

MethodPathDescription
GET/api/v3/projectsList published and accessible projects
GET/api/v3/projects/:idGet full project as FHIR bundle
GET/api/v3/citationsList citations for a project
GET/api/v3/citations/:idGet a citation
GET/api/v3/key_questionsList key questions
GET/api/v3/extractionsList extractions
GET/api/v3/extractions/:idGet extraction as FHIR ArtifactAssessment
GET/api/v3/sd_meta_dataList SR360 records
GET/api/v3/sd_meta_data/:idGet SR360 as FHIR EvidenceReport
GET/api/v3/extraction_forms_projectsList extraction form templates
POST/api/v3/fhir_importsImport a FHIR bundle
GET/api/v3/artifact_assessmentsList artifact assessments
GET/api/v3/usersGet 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. :::