openapi: 3.2.0
info:
title: Nomad Health Default API
version: '1.0'
description: 'Operations tagged default across 2 of this provider''s published API definitions: nomad-health-api-openapi.yml, nomad-health-platform-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://nomadhealth.com/api
tags:
- name: default
description: Default namespace
paths:
/admin-references/{provider_id}:
parameters:
- name: provider_id
in: path
required: true
schema:
type: string
get:
responses:
'200':
description: Success
operationId: get_admin_reference_api
tags:
- default
post:
responses:
'200':
description: Success
operationId: post_admin_reference_api
tags:
- default
/admin-references/{provider_id}/{reference_id}:
parameters:
- name: provider_id
in: path
required: true
schema:
type: string
- name: reference_id
in: path
required: true
schema:
type: string
put:
responses:
'200':
description: Success
operationId: put_admin_reference_detail_api
tags:
- default
delete:
responses:
'200':
description: Success
operationId: delete_admin_reference_detail_api
tags:
- default
/apply/{jobpost_id}/submit/:
parameters:
- name: jobpost_id
in: path
required: true
schema:
type: string
post:
responses:
'200':
description: Success
operationId: post_submit_application_api
tags:
- default
/emr_system:
get:
responses:
'200':
description: Success
summary: Returns full list of dictionary EmrSystem objects
operationId: get_emr_api
tags:
- default
/facility/facility_autocomplete:
get:
responses:
'200':
description: Success
summary: Get route for the facility autocomplete API
description: "Args:\n q (str): Taken from the QueryString to build the prefix\n\nReturns:\n Reponse with data as a List of dictionaries (defined in FacilityAutocompleteResponse)"
operationId: get_facility_autocomplete_api
tags:
- default
/facility/{facility_id}/photo/{photo_id}:
parameters:
- name: facility_id
in: path
required: true
schema:
type: string
- name: photo_id
in: path
required: true
schema:
type: string
put:
responses:
'200':
description: Success
summary: Set the hero image of a facility by moving the given
description: photo to the front of the facility.photos list.
operationId: put_facility_photo_api
tags:
- default
/facility/{id}:
parameters:
- name: id
in: path
required: true
schema:
type: string
get:
responses:
'200':
description: Success
operationId: get_facility_api
tags:
- default
/facility/{id}/jobposts/:
parameters:
- name: id
in: path
required: true
schema:
type: string
get:
responses:
'200':
description: Success
operationId: get_facilty_job_posts_api
tags:
- default
/facility/{id}/weather:
parameters:
- name: id
in: path
required: true
schema:
type: string
get:
responses:
'200':
description: Success
operationId: get_facility_weather_api
tags:
- default
/job-preferences/:
put:
responses:
'200':
description: Success
operationId: put_job_post_preference_api
tags:
- default
get:
responses:
'200':
description: Success
operationId: get_job_post_preference_api
tags:
- default
post:
responses:
'200':
description: Success
operationId: post_job_post_preference_api
tags:
- default
/jobposts/top-matches/:
get:
responses:
'200':
description: Success
operationId: get_job_post_top_matches_api
tags:
- default
/notifications/mobile-preferences/:
post:
responses:
'200':
description: Success
operationId: post_push_notification_preferences_api
tags:
- default
/nurse/certifications:
get:
responses:
'200':
description: Success
operationId: get_nurse_api
tags:
- default
/one-time-link/:
post:
responses:
'200':
description: Success
summary: Generates a one time link for a given url
operationId: post_one_time_link_api
tags:
- default
/open-api-spec/:
get:
responses:
'200':
description: Success
operationId: get_open_api_spec_api
tags:
- default
/region:
get:
responses:
'200':
description: Success
operationId: get_region_resource
tags:
- default
/user/{user_id}/profile/:
parameters:
- name: user_id
in: path
required: true
schema:
type: string
get:
responses:
'200':
description: Success
operationId: get_user_profile_api
tags:
- default
/waitlist:
get:
responses:
'200':
description: Success
operationId: get_waitlist_api
tags:
- default
/api/v1/account-manager/:
get:
responses:
'200':
description: Success
operationId: get_account_manager_list_resource
tags:
- default
/api/v1/account-manager/{id}/:
parameters:
- name: id
in: path
required: true
schema:
type: string
get:
responses:
'200':
description: Success
operationId: get_account_manager_detail_resource
tags:
- default
/api/v1/accounts/me/:
put:
responses:
'200':
description: Success
operationId: put_accounts_me_resource
tags:
- default
patch:
responses:
'200':
description: Success
operationId: patch_accounts_me_resource
tags:
- default
get:
responses:
'200':
description: Success
operationId: get_accounts_me_resource
tags:
- default
/api/v1/admin-accounts/{id}/:
parameters:
- name: id
in: path
required: true
schema:
type: string
get:
responses:
'200':
description: Success
operationId: get_admin_accounts_resource
tags:
- default
/api/v1/admin-agency/:
post:
responses:
'200':
description: Success
operationId: post_admin_agency_resource
tags:
- default
get:
responses:
'200':
description: Success
operationId: get_admin_agency_resource
tags:
- default
/api/v1/admin-agency/{id}/:
parameters:
- name: id
in: path
required: true
schema:
type: string
patch:
responses:
'200':
description: Success
operationId: patch_admin_agency_detail_resource
tags:
- default
get:
responses:
'200':
description: Success
operationId: get_admin_agency_detail_resource
tags:
- default
/api/v1/admin-application-review/data-reviews/:
post:
responses:
'200':
description: Success
operationId: post_admin_data_reviews_list_resource
tags:
- default
/api/v1/admin-application-review/external-verifications/:
post:
responses:
'200':
description: Success
operationId: post_admin_external_verifications_resource
tags:
- default
/api/v1/admin-application-review/sections/:
get:
responses:
'200':
description: Success
operationId: get_admin_application_review_sections_list_resource
tags:
- default
/api/v1/admin-applications/{provider_id}/:
parameters:
- name: provider_id
in: path
required: true
schema:
type: string
patch:
responses:
'200':
description: Success
operationId: patch_admin_application_resource
tags:
- default
get:
responses:
'200':
description: Success
operationId: get_admin_application_resource
tags:
- default
/api/v1/admin-applications/{provider_id}/validation/:
parameters:
- name: provider_id
in: path
required: true
schema:
type: string
get:
responses:
'200':
description: Success
operationId: get_admin_application_validation_resource
tags:
- default
/api/v1/admin-documents/:
get:
responses:
'200':
description: Success
operationId: get_admin_documents_resource
tags:
- default
/api/v1/admin-documents/upload/:
post:
responses:
'200':
description: Success
operationId: post_admin_documents_upload_resource
tags:
- default
/api/v1/admin-facility/{id}/:
parameters:
- name: id
in: path
required: true
schema:
type: string
patch:
responses:
'200':
description: Success
operationId: patch_facility_admin_resource
tags:
- default
get:
responses:
'200':
description: Success
operationId: get_facility_admin_resource
tags:
- default
/api/v1/admin-facility/{id}/jobposts/:
parameters:
- name: id
in: path
required: true
schema:
type: string
get:
responses:
'200':
description: Success
operationId: get_facility_admin_job_posts_resource
tags:
- default
/api/v1/admin-jobposts/search/:
get:
responses:
'200':
description: Success
operationId: get_admin_jobposts_search_resource
tags:
- default
/api/v1/admin-lead/:
get:
responses:
'200':
description: Success
operationId: get_admin_lead_resource
tags:
- default
/api/v1/admin-lead/{id}/:
parameters:
- name: id
in: path
required: true
schema:
type: string
patch:
responses:
'200':
description: Success
operationId: patch_admin_lead_details_resource
tags:
- default
get:
responses:
'200':
description: Success
operationId: get_admin_lead_details_resource
tags:
- default
/api/v1/admin-license-checks/:
get:
responses:
'200':
description: Success
operationId: get_admin_license_checks_list
tags:
- default
/api/v1/admin-placements/search/:
get:
responses:
'200':
description: Success
operationId: get_admin_placements_search_resource
tags:
- default
/api/v1/admin-profile-evaluation/:
post:
responses:
'200':
description: Success
operationId: post_admin_profile_evaluation_api
tags:
- default
/api/v1/admin-saved-search:
post:
responses:
'200':
description: Success
operationId: post_admin_saved_search_api
tags:
- default
patch:
responses:
'200':
description: Success
operationId: patch_admin_saved_search_api
tags:
- default
get:
responses:
'200':
description: Success
operationId: get_admin_saved_search_api
tags:
- default
/api/v1/admin-saved-search/delete:
post:
responses:
'200':
description: Success
operationId: post_admin_saved_search_delete_api
tags:
- default
/api/v1/admin-user/:
post:
responses:
'200':
description: Success
operationId: post_admin_user_create_resource
tags:
- default
/api/v1/admin-user/form-options/:
get:
responses:
'200':
description: Success
operationId: get_admin_user_form_options_resource
tags:
- default
/api/v1/admin-user/{id}/:
parameters:
- name: id
in: path
required: true
schema:
type: string
put:
responses:
'200':
description: Success
operationId: put_admin_user_detail_resource
tags:
- default
get:
responses:
'200':
description: Success
operationId: get_admin_user_detail_resource
tags:
- default
/api/v1/admin-user/{id}/action/:
parameters:
- name: id
in: path
required: true
schema:
type: string
post:
responses:
'200':
description: Success
operationId: post_admin_user_action_resource
tags:
- default
/api/v1/admin-users/:
get:
responses:
'200':
description: Success
operationId: get_admin_users_v1_api
tags:
- default
/api/v1/admin-vms/:
post:
responses:
'200':
description: Success
operationId: post_admin_vms_resource
tags:
- default
get:
responses:
'200':
description: Success
operationId: get_admin_vms_resource
tags:
- default
/api/v1/admin-vms/{id}/:
parameters:
- name: id
in: path
required: true
schema:
type: string
patch:
responses:
'200':
description: Success
operationId: patch_admin_vms_detail_resource
tags:
- default
get:
responses:
'200':
description: Success
operationId: get_admin_vms_detail_resource
tags:
- default
/api/v1/admin/assignments:
post:
responses:
'200':
description: Success
operationId: post_assignments_resource
tags:
- default
get:
responses:
'200':
description: Success
operationId: get_assignments_resource
tags:
- default
/api/v1/admin/assignments/{assignment_id}:
parameters:
- name: assignment_id
in: path
required: true
schema:
type: string
put:
responses:
'200':
description: Success
operationId: put_update_assignment
tags:
- default
/api/v1/admin/assignments/{assignment_id}/bonus:
parameters:
- name: assignment_id
in: path
required: true
schema:
type: string
post:
responses:
'200':
description: Success
operationId: post_add_assignment_bonus
tags:
- default
/api/v1/admin/assignments/{assignment_id}/bonus/{bonus_id}:
parameters:
- name: assignment_id
in: path
required: true
schema:
type: string
- name: bonus_id
in: path
required: true
schema:
type: string
put:
responses:
'200':
description: Success
operationId: put_update_assignment_bonus
tags:
- default
/api/v1/admin/assignments/{assignment_id}/offers:
parameters:
- name: assignment_id
in: path
required: true
schema:
type: string
get:
responses:
'200':
description: Success
operationId: get_get_assignment_offers
tags:
- default
/api/v1/admin/credential-candidate-group/:
post:
responses:
'200':
description: Success
summary: Create a new credential candidate group
operationId: post_admin_credential_candidate_group_resource
tags:
- default
get:
responses:
'200':
description: Success
summary: List all credential candidate groups
operationId: get_admin_credential_candidate_group_resource
tags:
- default
/api/v1/admin/credential-candidate-group/documents/:
post:
responses:
'200':
description: Success
summary: Create a new credential candidate group
operationId: post_admin_credential_candidate_group_documents_resource
tags:
- default
/api/v1/admin/credential-candidate-group/{group_id}/:
parameters:
- name: group_id
in: path
required: true
schema:
type: string
put:
responses:
'200':
description: Success
summary: Update a credential candidate group
operationId: put_admin_credential_candidate_group_detail_resource
tags:
- default
get:
responses:
'200':
description: Success
summary: Get a specific credential candidate group
operationId: get_admin_credential_candidate_group_detail_resource
tags:
- default
/api/v1/admin/credential-candidate-group/{group_id}/candidates/:
parameters:
- name: group_id
in: path
required: true
schema:
type: string
post:
responses:
'200':
description: Success
summary: Create a new credential candidate within a group
operationId: post_admin_credential_candidate_group_candidate_resource
tags:
- default
/api/v1/admin/credential-candidate/{candidate_id}/:
parameters:
- name: candidate_id
in: path
required: true
schema:
type: string
put:
responses:
'200':
description: Success
summary: Update a credential candidate
operationId: put_admin_credential_candidate_resource
tags:
- default
get:
responses:
'200':
description: Success
summary: Get a credential candidate by ID
operationId: get_admin_credential_candidate_resource
tags:
- default
/api/v1/admin/credentialing/assignees/:
get:
responses:
'200':
description: Success
operationId: get_assignees
tags:
- default
/api/v1/admin/credentialing/categories/definition/:
get:
responses:
'200':
description: Success
operationId: get_admin_get_category_definition
tags:
- default
/api/v1/admin/credentialing/clinicians/search/:
get:
responses:
'200':
description: Success
operationId: get_clinician_search
tags:
- default
/api/v1/admin/credentialing/clinicians/view/:
get:
responses:
'200':
description: Success
operationId: get_admin_clinician_lookup
tags:
- default
/api/v1/admin/credentialing/credentials/:
get:
responses:
'200':
description: Success
operationId: get_provider_credentials_browse
tags:
- default
/api/v1/admin/credentialing/credentials/update/:
post:
responses:
'200':
description: Success
operationId: post_credential_update
tags:
- default
/api/v1/admin/credentialing/fx-compliance/requirements/status-update/:
patch:
responses:
'200':
description: Success
operationId: patch_fx_requirement_status_update
tags:
- default
/api/v1/admin/credentialing/fx-compliance/view/:
get:
responses:
'200':
description: Success
operationId: get_fx_clinician_lookup
tags:
- default
/api/v1/admin/credentialing/requirement-types/create/:
post:
responses:
'200':
description: Success
operationId: post_create_requirement_type
tags:
- default
/api/v1/admin/credentialing/requirement-types/search/:
get:
responses:
'200':
description: Success
operationId: get_requirement_type_search
tags:
- default
/api/v1/admin/credentialing/requirement-types/update/:
post:
responses:
'200':
description: Success
operationId: post_requirement_type_update
tags:
- default
/api/v1/admin/credentialing/requirements/clone:
post:
responses:
'200':
description: Success
operationId: post_clone_requirements
tags:
- default
/api/v1/admin/credentialing/requirements/complete-application-question/:
post:
responses:
'200':
description: Success
operationId: post_admin_requirement_application_question_complete
tags:
- default
/api/v1/admin/credentialing/requirements/complete/:
put:
responses:
'200':
description: Success
operationId: put_admin_requirements_complete
tags:
- default
/api/v1/admin/credentialing/requirements/create/:
post:
responses:
'200':
description: Success
operationId: post_create_requirements
tags:
- default
/api/v1/admin/credentialing/requirements/delete/:
post:
responses:
'200':
description: Success
operationId: post_delete_requirement
tags:
- default
/api/v1/admin/credentialing/requirements/initialize/:
post:
responses:
'200':
description: Success
operationId: post_placement_requirements_initialize
tags:
- default
/api/v1/admin/credentialing/requirements/reset/:
post:
responses:
'200':
description: Success
operationId: post_requirement_reset
tags:
- default
/api/v1/admin/credentialing/requirements/status-update/:
post:
responses:
'200':
description: Success
operationId: post_admin_requirement_status_update
tags:
- default
/api/v1/admin/credentialing/templates/browse/:
get:
responses:
'200':
description: Success
operationId: get_facility_template_browse
tags:
- default
/api/v1/admin/credentialing/templates/bulk-create-from-placement/:
post:
responses:
'200':
description: Success
operationId: post_templates_bulk_create_from_placement
tags:
- default
/api/v1/admin/credentialing/templates/source/browse/:
get:
responses:
'200':
description: Success
operationId: get_requirement_source_browse
tags:
- default
/api/v1/admin/credentialing/templates/source/create/:
post:
responses:
'200':
description: Success
operationId: post_admin_requirement_source_create
tags:
- default
/api/v1/admin/credentialing/templates/source/update/:
put:
responses:
'200':
description: Success
operationId: put_admin_requirement_source_update
tags:
- default
/api/v1/admin/credentialing/templates/template/create/:
post:
responses:
'200':
description: Success
operationId: post_admin_templates_create
tags:
- default
/api/v1/admin/credentialing/templates/template/delete/:
post:
responses:
'200':
description: Success
operationId: post_admin_templates_deactivate
tags:
- default
/api/v1/admin/credentialing/templates/template/update/:
put:
responses:
'200':
description: Success
operationId: put_admin_templates_update
tags:
- default
/api/v1/admin/credentialing/timecards/export/:
get:
responses:
'200':
description: Success
operationId: get_admin_timecard_export
tags:
- default
/api/v1/admin/credentialing/timecards/requirements/create/:
post:
responses:
'200':
description: Success
operationId: post_admin_create_timecards
tags:
- default
/api/v1/admin/credentialing/timecards/requirements/list/:
get:
responses:
'200':
description: Success
operationId: get_admin_timecard_list
tags:
- default
/api/v1/admin/credentialing/timecards/requirements/update/:
patch:
responses:
'200':
description: Success
operationId: patch_admin_update_requirement
tags:
- default
/api/v1/admin/credentialing/timecards/{id}/:
parameters:
- name: id
in: path
required: true
schema:
type: string
get:
responses:
'200':
description: Success
operationId: get_admin_timecard_get
tags:
- default
/api/v1/admin/job-preferences/:
get:
responses:
'200':
description: Success
operationId: get_job_preferences_resource
tags:
- default
/api/v1/admin/offers/browse/:
get:
responses:
'200':
description: Success
operationId: get_browse_offers
tags:
- default
/api/v1/admin/offers/create/:
post:
responses:
'200':
description: Success
operationId: post_create_offers
tags:
- default
/api/v1/admin/offers/default-rates/{jobpost_id}:
parameters:
- name: jobpost_id
in: path
required: true
schema:
type: string
get:
responses:
'200':
description: Success
operationId: get_bill_rate_modifiers
tags:
- default
/api/v1/admin/offers/publish/:
put:
responses:
'200':
description: Success
operationId: put_publish_offer
tags:
- default
/api/v1/admin/offers/status/:
put:
responses:
'200':
description: Success
operationId: put_update_acceptance_status
tags:
- default
/api/v1/admin/offers/update-contract:
put:
responses:
'200':
description: Success
operationId: put_update_offers_contract
tags:
- default
/api/v1/admin/offers/update-notes:
put:
responses:
'200':
description: Success
operationId: put_update_offers_notes
tags:
- default
/api/v1/admin/offers/update/:
put:
responses:
'200':
description: Success
operationId: put_update_offers
tags:
- default
/api/v1/admin/offers/view/{offer_id}/:
parameters:
- name: offer_id
in: path
required: true
schema:
type: string
get:
responses:
'200':
description: Success
operationId: get_view_offer
tags:
- default
/api/v1/admin/offers/zendesk/{offer_id}:
parameters:
- name: offer_id
in: path
required: true
schema:
type: string
post:
responses:
'200':
description: Success
operationId: post_upsert_offer_zendesk_ticket
tags:
- default
/api/v1/admin/premier-navigator/acknowledge-recent-events/:
put:
responses:
'200':
description: Success
summary: Acknowledges a provider's recent events for a logged-in premier navigator
operationId: put_premier_navigator_admin_acknowledge_recent_events_resource
tags:
- default
/api/v1/admin/premier-navigator/availability-date/{provider_id}/:
parameters:
- name: provider_id
in: path
required: true
schema:
type: string
put:
responses:
'200':
description: Success
summary: Updates the availability date for a provider
operationId: put_premier_navigator_availability_date_resource
tags:
- default
/api/v1/admin/premier-navigator/available-voice-endpoints/:
get:
responses:
'200':
description: Success
operationId: get_premier_navigator_available_voice_endpoints_resource
tags:
- default
/api/v1/admin/premier-navigator/claim-provider/:
put:
responses:
'200':
description: Success
summary: Claims a provider for a logged-in premier navigator
operationId: put_premier_navigator_admin_claim_provider_resource
tags:
- default
/api/v1/admin/premier-navigator/claimed-queue/:
get:
responses:
'200':
description: Success
operationId: get_premier_navigator_admin_claimed_queue_list_resource
tags:
- default
/api/v1/admin/premier-navigator/jobpost-communication/:
post:
responses:
'200':
description: Success
operationId: post_premier_navigator_admin_jobpost_communication_resource
tags:
- default
get:
responses:
'200':
description: Success
operationId: get_premier_navigator_admin_jobpost_communication_resource
tags:
- default
/api/v1/admin/premier-navigator/live-jobs-v2/:
get:
responses:
'200':
description: Success
operationId: get_premier_navigator_admin_live_jobs_v2_resource
tags:
- default
/api/v1/admin/premier-navigator/live-jobs/:
get:
responses:
'200':
description: Success
operationId: get_premier_navigator_admin_live_jobs_resource
tags:
- default
/api/v1/admin/premier-navigator/messages/:
get:
responses:
'200':
description: Success
operationId: get_premier_navigator_messages_list_resource
tags:
- default
/api/v1/admin/premier-navigator/messages/conversations/:
get:
responses:
'200':
description: Success
operationId: get_premier_navigator_conversations_list_resource
tags:
- default
/api/v1/admin/premier-navigator/messages/conversations/{conversation_id}/mark-read/:
parameters:
- name: conversation_id
in: path
required: true
schema:
type: string
post:
responses:
'200':
description: Success
operationId: post_mark_conversation_read_resource
tags:
- default
/api/v1/admin/premier-navigator/messages/mark-read/:
post:
responses:
'200':
description: Success
operationId: post_mark_messages_read_resource
tags:
- default
/api/v1/admin/premier-navigator/messages/send/:
post:
responses:
'200':
description: Success
operationId: post_premier_navigator_send_message_resource
tags:
- default
/api/v1/admin/premier-navigator/messages/suggested-messages/:
get:
responses:
'200':
description: Success
operationId: get_premier_navigator_suggested_message_resource
tags:
- default
/api/v1/admin/premier-navigator/messages/suggested-messages/generate/:
post:
responses:
'200':
description: Success
operationId: post_premier_navigator_generate_suggested_message_resource
tags:
- default
/api/v1/admin/premier-navigator/messages/suggested-messages/task/{task_id}/:
parameters:
- name: task_id
in: path
required: true
schema:
type: string
get:
responses:
'200':
description: Success
operationId: get_premier_navigator_get_suggested_message_task_resource
tags:
- default
/api/v1/admin/premier-navigator/messages/unread-count/:
get:
responses:
'200':
description: Success
operationId: get_message_unread_count_resource
tags:
- default
/api/v1/admin/premier-navigator/messages/voice-calls/{call_id}/status/:
parameters:
- name: call_id
in: path
required: true
schema:
type: string
get:
responses:
'200':
description: Success
operationId: get_voice_message_status_resource
tags:
- default
/api/v1/admin/premier-navigator/messages/{message_id}/attachment/{attachment_id}/:
parameters:
- name: message_id
in: path
required: true
schema:
type: string
- name: attachment_id
in: path
required: true
schema:
type: string
get:
responses:
'200':
description: Success
operationId: get_mms_media_resource
tags:
- default
/api/v1/admin/premier-navigator/messages/{message_id}/recording/:
parameters:
- name: message_id
in: path
required: true
schema:
type: string
get:
responses:
'200':
description: Success
operationId: get_vo
# --- truncated at 32 KB (111 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/nomad-health/refs/heads/main/openapi/nomad-health-default-api-openapi.yml