Get personalized survey link for a contact

Retrieves a personalized link for a specific survey.

GET /surveys/{surveyId}/contact-links/contacts/{contactId}

Try it

Get personalized survey link for a contact

cURL

curl --request GET \
  --url https://app.formbricks.com/api/v2/surveys/{surveyId}/contact-links/contacts/{contactId}/ \
  --header 'x-api-key: <api-key>'

200

{
  "data": {
    "surveyUrl": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

x-api-key · string · header · required

Use your Formbricks x-api-key to authenticate.

Path Parameters

surveyId · string · required

The ID of the survey The ID of the survey

contactId · string · required

The ID of the contact The ID of the contact

Query Parameters

expirationDays

Number of days until the generated JWT expires. If not provided, there is no expiration. Number of days until the generated JWT expires. If not provided, there is no expiration.

Required range: x >= 1

Response

200 - application/json

Personalized survey link retrieved successfully.

data · object

Show child attributes

data. surveyUrl · string<uri> · required

data. expiresAt · string<date-time> | null

The date and time the link expires, null if no expiration