Get invite link

GET /v1/api/studies/{study_id}/interview-link Requires links:read

Get the study's invite link — the durable URL the user shares with participants. In Test mode it opens the safe preview experience; after the user selects Go live, it admits real participants to Live mode.

Parameters

study_id path required

string <uuid>

Responses

200 Successful Response

url

string required

Absolute invite URL (e.g. https://www.heyjuno.co/chat/{token}). The user shares it with participants; it is durable across lifecycle changes.

mode

enum("test", "live", "paused", "closed") required

The study's lifecycle value at the time of this response. Advisory only — participant behavior follows the value when they open the link.

422 Validation Error

ValidationError[]

cURL

curl 'https://api.heyjuno.co/v1/api/studies/3fa85f64-5717-4562-b3fc-2c963f66afa6/interview-link' \
  -H 'Authorization: Bearer $JUNO_API_KEY'

Example response

{
  "url": "string",
  "mode": "test"
}