Forta Health Clients API
The clients API from Forta Health — 7 operation(s) for clients.
Operations 11
Documentation
Authentication
https://artifacts.apis.io/forta-health/authentication/forta-health-authentication.yml
The clients API from Forta Health — 7 operation(s) for clients.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/forta-health:forta-health-clients-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Fast Clients API
version: 0.1.0
tags:
- name: Clients
paths:
/api/v1/clients/{client_id}/clinical_status/:
put:
tags:
- Clients
summary: Set Clinical Status
operationId: set_clinical_status_api_v1_clients__client_id__clinical_status__put
security:
- HTTPBearer: []
parameters:
- name: client_id
in: path
required: true
schema:
type: integer
title: Client Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ClientClinicalStatusUpdateRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ClientResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/clients/:
post:
tags:
- Clients
summary: Create Client
operationId: create_client_api_v1_clients__post
security:
- HTTPBearer: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ClientCreate'
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ClientResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- Clients
summary: Get All Clients
operationId: get_all_clients_api_v1_clients__get
security:
- HTTPBearer: []
parameters:
- name: clinical_status
in: query
required: false
schema:
anyOf:
- type: array
items:
type: string
- type: 'null'
default:
- CLINICAL
title: Clinical Status
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ClientWithAddressListResponse'
title: Response Get All Clients Api V1 Clients Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/clients/{client_id}/:
patch:
tags:
- Clients
summary: Patch Client
operationId: patch_client_api_v1_clients__client_id___patch
security:
- HTTPBearer: []
parameters:
- name: client_id
in: path
required: true
schema:
type: integer
title: Client Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ClientPatch'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ClientResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- Clients
summary: Get Client
operationId: get_client_api_v1_clients__client_id___get
security:
- HTTPBearer: []
parameters:
- name: client_id
in: path
required: true
schema:
type: integer
title: Client Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ClientDetailedResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/clients/families/:
get:
tags:
- Clients
summary: Fetch Client Families
operationId: fetch_client_families_api_v1_clients_families__get
security:
- HTTPBearer: []
parameters:
- name: client_id
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
title: Client Id
- name: date_active
in: query
required: false
schema:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Date Active
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ClientFamilyListResponse'
title: Response Fetch Client Families Api V1 Clients Families Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/clients/{client_id}/reset_assessment_allocation/:
put:
tags:
- Clients
summary: Reset Client Assessment Allocation
operationId: reset_client_assessment_allocation_api_v1_clients__client_id__reset_assessment_allocation__put
security:
- HTTPBearer: []
parameters:
- name: client_id
in: path
required: true
schema:
type: integer
title: Client Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ClientAssessmentAllocationReset'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/clients/{client_id}/modifier_matrix/:
post:
tags:
- Clients
summary: Create Client Modifier Matrix Row
operationId: create_client_modifier_matrix_row_api_v1_clients__client_id__modifier_matrix__post
security:
- HTTPBearer: []
parameters:
- name: client_id
in: path
required: true
schema:
type: integer
title: Client Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ClientPayorModifierMatrixCreate'
responses:
'201':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ClientPayorModifierMatrixResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- Clients
summary: Get Client Modifier Matrix Rows
operationId: get_client_modifier_matrix_rows_api_v1_clients__client_id__modifier_matrix__get
security:
- HTTPBearer: []
parameters:
- name: client_id
in: path
required: true
schema:
type: integer
title: Client Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ClientPayorModifierMatrixResponse'
title: Response Get Client Modifier Matrix Rows Api V1 Clients Client Id Modifier Matrix Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/clients/{client_id}/modifier_matrix/{modifier_matrix_id}/:
put:
tags:
- Clients
summary: Replace Client Modifier Matrix Row
operationId: replace_client_modifier_matrix_row_api_v1_clients__client_id__modifier_matrix__modifier_matrix_id___put
security:
- HTTPBearer: []
parameters:
- name: client_id
in: path
required: true
schema:
type: integer
title: Client Id
- name: modifier_matrix_id
in: path
required: true
schema:
type: integer
title: Modifier Matrix Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ClientPayorModifierMatrixCreate'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ClientPayorModifierMatrixResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- Clients
summary: Delete Client Modifier Matrix Row
operationId: delete_client_modifier_matrix_row_api_v1_clients__client_id__modifier_matrix__modifier_matrix_id___delete
security:
- HTTPBearer: []
parameters:
- name: client_id
in: path
required: true
schema:
type: integer
title: Client Id
- name: modifier_matrix_id
in: path
required: true
schema:
type: integer
title: Modifier Matrix Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
ClientClinicalStatusUpdateRequest:
properties:
status:
$ref: '#/components/schemas/ClinicalStatusEnum'
reason:
anyOf:
- $ref: '#/components/schemas/ClinicalStatusReasonEnum'
- type: 'null'
type: object
required:
- status
title: ClientClinicalStatusUpdateRequest
ProviderResponseWithoutAddress:
properties:
id:
type: integer
title: Id
first_name:
type: string
title: First Name
last_name:
type: string
title: Last Name
email:
type: string
format: email
title: Email
status:
type: string
title: Status
clinical_status:
$ref: '#/components/schemas/ClinicalStatusEnum'
phone:
anyOf:
- type: string
- type: 'null'
title: Phone
type: object
required:
- id
- first_name
- last_name
- email
- status
- clinical_status
title: ProviderResponseWithoutAddress
ClientPayorModifierMatrixCreate:
properties:
payor_id:
type: integer
title: Payor Id
service_code_id:
type: integer
title: Service Code Id
location:
$ref: '#/components/schemas/LocationEnumVersion1'
delivery_method:
$ref: '#/components/schemas/app__api__schemas__sessions__session_enums__DeliveryMethodEnum'
modifier_1:
anyOf:
- type: string
pattern: ^[A-Za-z0-9]{2}$
- type: 'null'
title: Modifier 1
modifier_2:
anyOf:
- type: string
pattern: ^[A-Za-z0-9]{2}$
- type: 'null'
title: Modifier 2
modifier_3:
anyOf:
- type: string
pattern: ^[A-Za-z0-9]{2}$
- type: 'null'
title: Modifier 3
modifier_4:
anyOf:
- type: string
pattern: ^[A-Za-z0-9]{2}$
- type: 'null'
title: Modifier 4
type: object
required:
- payor_id
- service_code_id
- location
- delivery_method
title: ClientPayorModifierMatrixCreate
ClientWithAddressListResponse:
properties:
first_name:
type: string
title: First Name
last_name:
type: string
title: Last Name
sex:
$ref: '#/components/schemas/Sex'
dob:
type: string
format: date
title: Dob
clinical_status:
$ref: '#/components/schemas/ClinicalStatusEnum'
id:
type: integer
title: Id
street_address_zip:
anyOf:
- type: string
- type: 'null'
title: Street Address Zip
street_address_city:
anyOf:
- type: string
- type: 'null'
title: Street Address City
street_address_state:
anyOf:
- type: string
- type: 'null'
title: Street Address State
type: object
required:
- first_name
- last_name
- sex
- dob
- clinical_status
- id
title: ClientWithAddressListResponse
ClientPayorModifierMatrixResponse:
properties:
payor_id:
type: integer
title: Payor Id
service_code_id:
type: integer
title: Service Code Id
location:
$ref: '#/components/schemas/LocationEnumVersion1'
delivery_method:
$ref: '#/components/schemas/app__api__schemas__sessions__session_enums__DeliveryMethodEnum'
modifier_1:
anyOf:
- type: string
pattern: ^[A-Za-z0-9]{2}$
- type: 'null'
title: Modifier 1
modifier_2:
anyOf:
- type: string
pattern: ^[A-Za-z0-9]{2}$
- type: 'null'
title: Modifier 2
modifier_3:
anyOf:
- type: string
pattern: ^[A-Za-z0-9]{2}$
- type: 'null'
title: Modifier 3
modifier_4:
anyOf:
- type: string
pattern: ^[A-Za-z0-9]{2}$
- type: 'null'
title: Modifier 4
id:
type: integer
title: Id
client_id:
type: integer
title: Client Id
service_code:
anyOf:
- $ref: '#/components/schemas/ServiceCodeEnum'
- type: string
title: Service Code
type: object
required:
- payor_id
- service_code_id
- location
- delivery_method
- id
- client_id
- service_code
title: ClientPayorModifierMatrixResponse
ClientListResponse:
properties:
first_name:
type: string
title: First Name
last_name:
type: string
title: Last Name
sex:
$ref: '#/components/schemas/Sex'
dob:
type: string
format: date
title: Dob
clinical_status:
$ref: '#/components/schemas/ClinicalStatusEnum'
id:
type: integer
title: Id
type: object
required:
- first_name
- last_name
- sex
- dob
- clinical_status
- id
title: ClientListResponse
Sex:
type: string
enum:
- female
- male
- other
- unknown
title: Sex
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
type: object
required:
- loc
- msg
- type
title: ValidationError
app__api__schemas__sessions__session_enums__DeliveryMethodEnum:
type: string
enum:
- Telehealth
- In-person
title: DeliveryMethodEnum
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
ServiceCodeEnum:
type: string
enum:
- '97151'
- '97152'
- '97153'
- '97155'
- '97156'
- '97157'
- '99366'
title: ServiceCodeEnum
ClientResponse:
properties:
first_name:
type: string
title: First Name
last_name:
type: string
title: Last Name
sex:
$ref: '#/components/schemas/Sex'
dob:
type: string
format: date
title: Dob
middle_name:
anyOf:
- type: string
- type: 'null'
title: Middle Name
email:
anyOf:
- type: string
format: email
- type: 'null'
title: Email
street_address_line_one:
anyOf:
- type: string
- type: 'null'
title: Street Address Line One
street_address_line_two:
anyOf:
- type: string
- type: 'null'
title: Street Address Line Two
street_address_zip:
anyOf:
- type: string
- type: 'null'
title: Street Address Zip
street_address_city:
anyOf:
- type: string
- type: 'null'
title: Street Address City
street_address_state:
anyOf:
- type: string
maxLength: 2
- type: 'null'
title: Street Address State
phone:
anyOf:
- type: string
- type: 'null'
title: Phone
id:
type: integer
title: Id
clinical_status:
$ref: '#/components/schemas/ClinicalStatusEnum'
clinical_status_reason:
anyOf:
- $ref: '#/components/schemas/ClinicalStatusReasonEnum'
- type: 'null'
street_address_latitude:
anyOf:
- type: number
maximum: 90.0
minimum: -90.0
- type: 'null'
title: Street Address Latitude
street_address_longitude:
anyOf:
- type: number
maximum: 180.0
minimum: -180.0
- type: 'null'
title: Street Address Longitude
type: object
required:
- first_name
- last_name
- sex
- dob
- id
- clinical_status
title: ClientResponse
ProviderListResponseForGPSN:
properties:
id:
type: integer
title: Id
name:
type: string
title: Name
email:
type: string
format: email
title: Email
phone:
anyOf:
- type: string
- type: 'null'
title: Phone
type: object
required:
- id
- name
- email
title: ProviderListResponseForGPSN
LocationEnumVersion1:
type: string
enum:
- Home
- Community
- School
title: LocationEnumVersion1
ClientPatch:
properties:
first_name:
anyOf:
- type: string
- type: 'null'
title: First Name
last_name:
anyOf:
- type: string
- type: 'null'
title: Last Name
middle_name:
anyOf:
- type: string
- type: 'null'
title: Middle Name
sex:
anyOf:
- $ref: '#/components/schemas/Sex'
- type: 'null'
dob:
anyOf:
- type: string
format: date
- type: 'null'
title: Dob
street_address_line_one:
anyOf:
- type: string
- type: 'null'
title: Street Address Line One
street_address_line_two:
anyOf:
- type: string
- type: 'null'
title: Street Address Line Two
street_address_zip:
anyOf:
- type: string
- type: 'null'
title: Street Address Zip
street_address_city:
anyOf:
- type: string
- type: 'null'
title: Street Address City
street_address_state:
anyOf:
- type: string
maxLength: 2
- type: 'null'
title: Street Address State
phone:
anyOf:
- type: string
- type: 'null'
title: Phone
street_address_latitude:
anyOf:
- type: number
maximum: 90.0
minimum: -90.0
- type: 'null'
title: Street Address Latitude
street_address_longitude:
anyOf:
- type: number
maximum: 180.0
minimum: -180.0
- type: 'null'
title: Street Address Longitude
type: object
title: ClientPatch
description: 'Partial client update. Omitted fields are unchanged; explicit nulls are applied
only for nullable fields. Required identity fields may be omitted but not nulled.'
ClientAssessmentAllocationReset:
properties:
date_allocated:
type: string
format: date
title: Date Allocated
type: object
required:
- date_allocated
title: ClientAssessmentAllocationReset
ClientCreate:
properties:
first_name:
type: string
title: First Name
last_name:
type: string
title: Last Name
sex:
$ref: '#/components/schemas/Sex'
dob:
type: string
format: date
title: Dob
middle_name:
anyOf:
- type: string
- type: 'null'
title: Middle Name
email:
anyOf:
- type: string
format: email
- type: 'null'
title: Email
street_address_line_one:
anyOf:
- type: string
- type: 'null'
title: Street Address Line One
street_address_line_two:
anyOf:
- type: string
- type: 'null'
title: Street Address Line Two
street_address_zip:
anyOf:
- type: string
- type: 'null'
title: Street Address Zip
street_address_city:
anyOf:
- type: string
- type: 'null'
title: Street Address City
street_address_state:
anyOf:
- type: string
maxLength: 2
- type: 'null'
title: Street Address State
phone:
anyOf:
- type: string
- type: 'null'
title: Phone
street_address_latitude:
anyOf:
- type: number
maximum: 90.0
minimum: -90.0
- type: 'null'
title: Street Address Latitude
street_address_longitude:
anyOf:
- type: number
maximum: 180.0
minimum: -180.0
- type: 'null'
title: Street Address Longitude
type: object
required:
- first_name
- last_name
- sex
- dob
title: ClientCreate
ClinicalStatusReasonEnum:
type: string
enum:
- DISCHARGED
- TERMINATED
- RESIGNED
title: ClinicalStatusReasonEnum
ClinicalStatusEnum:
type: string
enum:
- PRE CLINICAL
- CLINICAL
- ON HOLD
- OFFBOARDED
- LIMITED ACCESS GUARDIAN
title: ClinicalStatusEnum
ClientFamilyListResponse:
properties:
client:
$ref: '#/components/schemas/ClientListResponse'
parents_and_caregivers:
items:
$ref: '#/components/schemas/ProviderListResponseForGPSN'
type: array
title: Parents And Caregivers
type: object
required:
- client
- parents_and_caregivers
title: ClientFamilyListResponse
ClientDetailedResponse:
properties:
first_name:
type: string
title: First Name
last_name:
type: string
title: Last Name
sex:
$ref: '#/components/schemas/Sex'
dob:
type: string
format: date
title: Dob
middle_name:
anyOf:
- type: string
- type: 'null'
title: Middle Name
email:
anyOf:
- type: string
format: email
- type: 'null'
title: Email
street_address_line_one:
anyOf:
- type: string
- type: 'null'
title: Street Address Line One
street_address_line_two:
anyOf:
- type: string
- type: 'null'
title: Street Address Line Two
street_address_zip:
anyOf:
- type: string
- type: 'null'
title: Street Address Zip
street_address_city:
anyOf:
- type: string
- type: 'null'
title: Street Address City
street_address_state:
anyOf:
- type: string
maxLength: 2
- type: 'null'
title: Street Address State
phone:
anyOf:
- type: string
- type: 'null'
title: Phone
id:
type: integer
title: Id
clinical_status:
$ref: '#/components/schemas/ClinicalStatusEnum'
clinical_status_reason:
anyOf:
- $ref: '#/components/schemas/ClinicalStatusReasonEnum'
- type: 'null'
street_address_latitude:
anyOf:
- type: number
maximum: 90.0
minimum: -90.0
- type: 'null'
title: Street Address Latitude
street_address_longitude:
anyOf:
- type: number
maximum: 180.0
minimum: -180.0
- type: 'null'
title: Street Address Longitude
active_treatment_plan_id:
anyOf:
- type: integer
- type: 'null'
title: Active Treatment Plan Id
providers:
items:
$ref: '#/components/schemas/ProviderResponseWithoutAddress'
type: array
title: Providers
type: object
required:
- first_name
- last_name
- sex
- dob
- id
- clinical_status
- providers
title: ClientDetailedResponse
securitySchemes:
HTTPBearer:
type: http
scheme: bearer
x-provenance:
method: harvested
publisher: Forta Health
source: https://api.prod.fortahealth.com/openapi.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)