How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Forta Health Sessions API

The sessions API from Forta Health — 38 operation(s) for sessions.

Forta Health Sessions API is one of 34 APIs that Forta Health publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Sessions. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 46 operations across 38 paths, and defines 92 schemas. It is described by OpenAPI 3.2.0, at version 0.1.0.

Requests are made against the base URL https://api.prod.fortahealth.com/api/v1/.

46 operations 38 paths 92 schemas 5 DELETE12 GET10 PATCH11 POST8 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1.0
Base URL
https://api.prod.fortahealth.com/api/v1/
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Forta Health Sessions API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (HTTPBearer).

Paths & Operations 46

Across 38 paths, the API surfaces 46 operations — 5 DELETE, 12 GET, 10 PATCH, 11 POST, 8 PUT. Each is listed below with its method, path, parameters, and response codes.

sessions 46
POST
/api/v1/sessions/
Create Session
create_session_api_v1_sessions__post body → 201422
GET
/api/v1/sessions/
Get Sessions
get_sessions_api_v1_sessions__get 11 params → 200422
GET
/api/v1/sessions/awaiting_guardian_signature/
Get Sessions Awaiting Guardian Signature
get_sessions_awaiting_guardian_signature_api_v1_sessions_awaiting_guardian_signature__get → 200
POST
/api/v1/sessions/bay7/guardian_signature/
Bay7 Guardian Signature
bay7_guardian_signature_api_v1_sessions_bay7_guardian_signature__post 1 param body → 204422
GET
/api/v1/sessions/awaiting_acknowledgement/
Get Unacknowledged Sessions
get_unacknowledged_sessions_api_v1_sessions_awaiting_acknowledgement__get → 200
GET
/api/v1/sessions/claim_history/
Get Sessions With Claim History
get_sessions_with_claim_history_api_v1_sessions_claim_history__get 6 params → 200422
GET
/api/v1/sessions/{session_id}/
Get Session
get_session_api_v1_sessions__session_id___get 1 param → 200422
PATCH
/api/v1/sessions/{session_id}/
Patch Session
patch_session_api_v1_sessions__session_id___patch 1 param body → 200422
DELETE
/api/v1/sessions/{session_id}/
Delete Session
delete_session_api_v1_sessions__session_id___delete 1 param → 204422
PUT
/api/v1/sessions/{session_id}/stop/
Stop Session
stop_session_api_v1_sessions__session_id__stop__put 2 params body → 200422
PATCH
/api/v1/sessions/{session_id}/reset_status/
Reset Session Status
reset_session_status_api_v1_sessions__session_id__reset_status__patch 1 param → 200422
PUT
/api/v1/sessions/{session_id}/clinical_qa_reviews/{clinical_qa_review_id}/pdf_regenerate/
Queue To Regenerate Clinical Qa Review Pdf
queue_to_regenerate_clinical_qa_review_pdf_api_v1_sessions__session_id__clinical_qa_reviews__clinical_qa_review_id__pdf_regenerate__put 2 params → 201422
GET
/api/v1/sessions/{session_id}/trials/
Get Session Practiced Targets Trials
get_session_practiced_targets_trials_api_v1_sessions__session_id__trials__get 1 param → 200422
POST
/api/v1/sessions/{session_id}/trials/
Create Trial
create_trial_api_v1_sessions__session_id__trials__post 1 param body → 201422
PATCH
/api/v1/sessions/{session_id}/trials/{trial_id}/
Patch Trial
patch_trial_api_v1_sessions__session_id__trials__trial_id___patch 2 params body → 200422
DELETE
/api/v1/sessions/{session_id}/trials/{trial_id}/
Delete Trial
delete_trial_api_v1_sessions__session_id__trials__trial_id___delete 2 params → 200422
POST
/api/v1/sessions/{session_id}/trials/{trial_id}/duration_events/
Create Trial Duration Event
create_trial_duration_event_api_v1_sessions__session_id__trials__trial_id__duration_events__post 2 params body → 201422
PATCH
/api/v1/sessions/{session_id}/trials/{trial_id}/duration_events/{duration_event_id}/
Update Trial Duration Event
update_trial_duration_event_api_v1_sessions__session_id__trials__trial_id__duration_events__duration_event_id___patch 3 params body → 200422
DELETE
/api/v1/sessions/{session_id}/trials/{trial_id}/duration_events/{duration_event_id}/
Delete Trial Duration Event
delete_trial_duration_event_api_v1_sessions__session_id__trials__trial_id__duration_events__duration_event_id___delete 3 params → 200422
POST
/api/v1/sessions/{session_id}/trials/{trial_id}/rate_events/
Create Trial Rate Event
create_trial_rate_event_api_v1_sessions__session_id__trials__trial_id__rate_events__post 2 params body → 201422
PATCH
/api/v1/sessions/{session_id}/trials/{trial_id}/rate_events/{rate_event_id}/
Update Trial Rate Event
update_trial_rate_event_api_v1_sessions__session_id__trials__trial_id__rate_events__rate_event_id___patch 3 params body → 200422
DELETE
/api/v1/sessions/{session_id}/trials/{trial_id}/rate_events/{rate_event_id}/
Delete Trial Rate Event
delete_trial_rate_event_api_v1_sessions__session_id__trials__trial_id__rate_events__rate_event_id___delete 3 params → 200422
GET
/api/v1/sessions/{session_id}/download/
Download Session Pdf
download_session_pdf_api_v1_sessions__session_id__download__get 1 param → 200422
GET
/api/v1/sessions/{session_id}/clinical_qa_reviews/{clinical_qa_review_id}/download/
Get Clinical Qa Review Pdf
get_clinical_qa_review_pdf_api_v1_sessions__session_id__clinical_qa_reviews__clinical_qa_review_id__download__get 2 params → 200422
POST
/api/v1/sessions/{session_id}/clinical_qa_reviews/
Create Clinical Qa Review
create_clinical_qa_review_api_v1_sessions__session_id__clinical_qa_reviews__post 1 param body → 201422
PATCH
/api/v1/sessions/{session_id}/clinical_qa_reviews/{clinical_qa_review_id}/
Save Clinical Qa Review
save_clinical_qa_review_api_v1_sessions__session_id__clinical_qa_reviews__clinical_qa_review_id___patch 2 params body → 200422
DELETE
/api/v1/sessions/{session_id}/clinical_qa_reviews/{clinical_qa_review_id}/
Delete Clinical Qa Review
delete_clinical_qa_review_api_v1_sessions__session_id__clinical_qa_reviews__clinical_qa_review_id___delete 2 params body → 200422
PUT
/api/v1/sessions/{session_id}/clinical_qa_reviews/{clinical_qa_review_id}/stop/
Submit Clinical Qa Review
submit_clinical_qa_review_api_v1_sessions__session_id__clinical_qa_reviews__clinical_qa_review_id__stop__put 2 params body → 200422
POST
/api/v1/sessions/{session_id}/clinical_qa_reviews/{clinical_qa_review_id}/acknowledge/
Acknowledge Clinical Qa Review
acknowledge_clinical_qa_review_api_v1_sessions__session_id__clinical_qa_reviews__clinical_qa_review_id__acknowledge__post 2 params body → 201422
POST
/api/v1/sessions/{session_id}/clinical_qa_reviews/{clinical_qa_review_id}/discourses/
Create Clinical Qa Review Submission Discourse
create_clinical_qa_review_submission_discourse_api_v1_sessions__session_id__clinical_qa_reviews__clinical_qa_review_id__discourses__post 2 params body → 201422
GET
/api/v1/sessions/data/review_summary/
Fetch Review Summary
fetch_review_summary_api_v1_sessions_data_review_summary__get → 200
GET
/api/v1/sessions/data/trial_summary/
Fetch Trial Summary
fetch_trial_summary_api_v1_sessions_data_trial_summary__get 4 params → 200422
GET
/api/v1/sessions/data/utilization/
Get Utilization
get_utilization_api_v1_sessions_data_utilization__get 4 params → 200422
POST
/api/v1/sessions/{session_id}/narrative_suggestion/
Construct Session Narrative Suggestion
construct_session_narrative_suggestion_api_v1_sessions__session_id__narrative_suggestion__post 1 param → 201422
PATCH
/api/v1/sessions/{session_id}/symptoms-interventions/
Patch Session Symptoms Interventions
patch_session_symptoms_interventions_api_v1_sessions__session_id__symptoms_interventions__patch 1 param body → 200422
PATCH
/api/v1/sessions/{session_id}/progress-synopsis/
Patch Session Progress Synopsis
patch_session_progress_synopsis_api_v1_sessions__session_id__progress_synopsis__patch 1 param body → 200422
PATCH
/api/v1/sessions/{session_id}/narrative/
Patch Session Narrative
patch_session_narrative_api_v1_sessions__session_id__narrative__patch 1 param body → 200422
PUT
/api/v1/sessions/{session_id}/guardian_sign/
Guardian Sign Session
guardian_sign_session_api_v1_sessions__session_id__guardian_sign__put 2 params body → 200422
PATCH
/api/v1/sessions/{session_id}/terminate/
Terminate Session
terminate_session_api_v1_sessions__session_id__terminate__patch 1 param → 200422
PUT
/api/v1/sessions/{session_id}/make_unbillable/
Make Session Unbillable
make_session_unbillable_api_v1_sessions__session_id__make_unbillable__put 1 param → 204422
PUT
/api/v1/sessions/{session_id}/make_billable/
Make Session Billable
make_session_billable_api_v1_sessions__session_id__make_billable__put 1 param → 204422
PUT
/api/v1/sessions/{session_id}/edit/
Edit Session
edit_session_api_v1_sessions__session_id__edit__put 1 param → 204422
PUT
/api/v1/sessions/{session_id}/backdate/
Backdate Session
backdate_session_api_v1_sessions__session_id__backdate__put 1 param body → 204422
POST
/api/v1/sessions/{session_id}/evv/start
Start Evv Token
start_evv_token_api_v1_sessions__session_id__evv_start_post 2 params → 200422
POST
/api/v1/sessions/{session_id}/evv/end
End Evv Token
end_evv_token_api_v1_sessions__session_id__evv_end_post 2 params → 200422
GET
/api/v1/sessions/{session_id}/evv/status
Get Session Evv Status
get_session_evv_status_api_v1_sessions__session_id__evv_status_get 1 param → 200422

Schemas 92

The contract defines 92 schemas that model the data the API accepts and returns. The most detailed are DetailedSessionResponse (35 properties), ProviderResponse (29 properties), ClinicalQAReviewResponse (27 properties), SessionListResponseWithClaimHistory (23 properties). Each schema is shown below with its type and property counts.

ClinicalQAReviewCreate
object
2 properties 2 required
SessionBackdate
object
2 properties 2 required
UnacknowledgedSessionsResponse
object
2 properties 2 required
ClinicalStatusEnum
string
ClinicalQAListResponse
object
11 properties 7 required
ProviderAssignmentClinicalRelationshipEnum
string
app__api__schemas__sessions__trial__RateEventResponse
object
2 properties 2 required
EVVSessionStatusResponse
object
2 properties 2 required
ClinicalQAReviewSubmit
object
2 properties 2 required
app__api__schemas__sessions__trial__TrialResponse
object
9 properties 3 required
LocationEnumVersion2
string
GoalsAndTrialsResponse
object
ClinicalQAReviewStatusEnum
string
Bay
string
SessionGoalTimingRequest
object
3 properties 1 required
app__api__schemas__sessions__session_enums__DeliveryMethodEnum
string
Sex
string
GoalWithLinkResponse
object
6 properties 5 required
OccurrenceInstance
object
2 properties 1 required
SessionProgressSynopsisResponse
object
5 properties 2 required
SessionPatch
object
9 properties 6 required
BehaviorResponse
object
2 properties 2 required
EvidenceBasedInterventionsUsed
object
15 properties 13 required
Bay7GuardianSignatureRequest
object
BT-authenticated request; guardian identity comes from guardianauthtoken.
6 properties 5 required
SessionCreate
object
To create and start a session we need datestart and utcoffset We're inheriting clientid and providerid from the base class
10 properties 6 required
app__api__schemas__sessions__trial__TrialPatch
object
4 properties
ClientResponse
object
17 properties 6 required
ClinicalQAReviewSubmissionDiscourseResponse
object
6 properties 2 required
SessionStop
object
3 properties 3 required
ValidationError
object
3 properties 3 required
LinkedGoals
UtilizationResponse
object
7 properties 7 required
QABillingStatusEnum
string
ProviderResponse
object
29 properties 7 required
ClinicalQAReviewSave
object
14 properties
DurationEventPatch
object
1 property 1 required
SessionTerminateResponse
object
3 properties 3 required
SessionListResponseWithClaimHistory
object
23 properties 12 required
LinkedClaimResponse
object
5 properties 3 required
SessionBreakResponse
object
4 properties 2 required
Synopsis
object
2 properties 2 required
app__api__schemas__sessions__trial__DurationEventResponse
object
2 properties 2 required
ClinicalQAReviewAcknowledge
object
3 properties 3 required
TargetPhaseChangeData
object
3 properties 3 required
SessionProviderReviewSummary
object
3 properties 1 required
TrialCreate
object
1 property 1 required
ClinicalQAReviewSubmissionDiscourseCreate
object
4 properties 3 required
DetailedSessionResponse
object
35 properties 16 required
GoalSimpleResponse
object
4 properties 4 required
ClinicalQAReviewDeletionReasonEnum
string
SessionBreakRequest
object
2 properties 2 required
TargetResponseWithGoal
object
11 properties 5 required
LocationEnumVersion1
string
ProviderListResponse
object
6 properties 6 required
SessionDownloadPdfResponse
object
1 property 1 required
GoalTrialSummary
object
5 properties 4 required
EVVTokenCreateResponse
object
1 property 1 required
ClinicalQAReviewDeletion
object
2 properties 1 required
EvalSchemaVersionEnum
string
DurationEventCreate
object
1 property 1 required
EventMeasurementUnitEnum
string
SessionStatusEnum
string
PatchSessionNarrative
object
1 property 1 required
SessionNoteVersionEnum
string
ClientProgressEnum
string
JobTitleEnum
string
app__api__schemas__sessions__trial__RateEventPatch
object
1 property 1 required
GoalNameResponse
object
6 properties 5 required
SessionGoalTimingTypeEnum
string
ClinicalQAReviewResponse
object
27 properties 10 required
TargetTrialSummary
object
7 properties 6 required
SessionListResponse
object
21 properties 11 required
ClinicalQAReviewPDFUrl
object
1 property 1 required
SessionGoalTimingResponse
object
6 properties 2 required
ClaimStatusEnum
string
GuardianSignRequest
object
3 properties 3 required
HTTPValidationError
object
1 property
SessionSymptomsInterventionsResponse
object
3 properties 3 required
PatchSessionSymptomsInterventionsRequest
object
2 properties 2 required
ClinicalQAReviewVerdict
string
GoalTypeEnum
string
ClinicalStatusReasonEnum
string
EmploymentTypeEnum
string
app__api__schemas__sessions__trial__RateEventCreate
object
1 property 1 required
TrialData
object
16 properties 13 required
GoalAndTrialsResponse
object
7 properties 5 required
SessionNarrativeSuggestionResponse
object
1 property 1 required
ProviderStatusEnum
string
SessionNarrativeResponse
object
2 properties 2 required
ClientSignsSymptomsObserved
object
16 properties 13 required
PatchSessionProgressSynopsisRequest
object
4 properties 1 required
EVVSideStatusResponse
object
7 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

forta-health-sessions-api-openapi.yml Raw ↑

Other APIs Forta Health publishes across the network.

Forta Health Assessment Surveys API
Forta Health Behavior API
Forta Health Bt Supervisions API
Forta Health Claim Invoices API
Forta Health Claims API
Forta Health Client Assessments API
Forta Health Client Cohort Assignments API
Forta Health Client Facility Assignments API
Forta Health Client Supervisions API
Forta Health Clients API
Forta Health Cohorts API
Forta Health Email Cron Configs API
Where this information came from

This is an independent, third-party profile of Forta Health Sessions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.