Skip to main content
GET
Get a feedback popup

Authorizations

Authorization
string
header
default:Bearer sandbox_any_token_works
required

A 15-minute token bound to one patient and one enrollment, issued by POST /v1/oauth/token with the token-exchange grant. Treat it as opaque. When it expires, exchange a fresh assertion; there is no refresh token.

Path Parameters

feedback_request_id
string<uuid>
required

Response

The popup.

id
string<uuid>
required
Example:

"0190f5e3-4c5d-7e6f-8a90-b1c2d3e4f5a6"

status
enum<string>
required
Available options:
requested,
answered,
dismissed,
expired
Example:

"requested"

care_role
string
required

A care role on the coached plan. Today health_coach or fitness_coach; more may be added.

Pattern: ^[a-z][a-z0-9_]*$
Example:

"health_coach"

coach
object
required

The coach the feedback is about, as the patient sees them.

survey
object
required
requested_at
string<date-time>
required

ISO 8601 in UTC.

Example:

"2026-10-26T14:05:00Z"

expires_at
string<date-time> | null

After this the popup can't be answered; don't show it.

Example:

"2026-11-23T00:00:00Z"

answers
object | null

Set once answered.

Example:
answered_at
string<date-time> | null
Example:

null