Skip to content
API Docs/
API Reference
/
/
Get Care Navigation Setti...

Get Care Navigation Settings

Request

Retrieves the care navigation settings for the requesting practice group.

Security
apiKeyAuth and practiceGroupId
curl -i -X GET \
  https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/care-nav/settings \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
idstring^\d+$required
suspendedbooleanrequired
suspended_reasonstring or nullrequired
suspended_welcome_textstring or nullrequired
suspended_welcome_text_enabledbooleanrequired
in_hoursbooleanrequired
in_hours_welcome_textstring or nullrequired
in_hours_welcome_text_enabledbooleanrequired
out_of_hours_welcome_textstring or nullrequired
out_of_hours_welcome_text_enabledbooleanrequired
confirmation_messagestring or nullrequired
submission_textstring or nullrequired
urlstring or nullrequired
updated_atstring or null, (date-time)required
opening_hoursArray of objectsrequired
Response
{
  "id": "string",
  "suspended": true,
  "suspended_reason": "string",
  "suspended_welcome_text": "string",
  "suspended_welcome_text_enabled": true,
  "in_hours": true,
  "in_hours_welcome_text": "string",
  "in_hours_welcome_text_enabled": true,
  "out_of_hours_welcome_text": "string",
  "out_of_hours_welcome_text_enabled": true,
  "confirmation_message": "string",
  "submission_text": "string",
  "url": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "opening_hours": [
    { … }
  ]
}