Get survey links for contacts in a segment
curl --request GET \
--url https://app.formbricks.com/api/v2/management/surveys/{surveyId}/contact-links/segments/{segmentId} \
--header 'x-api-key: <api-key>'import requests
url = "https://app.formbricks.com/api/v2/management/surveys/{surveyId}/contact-links/segments/{segmentId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://app.formbricks.com/api/v2/management/surveys/{surveyId}/contact-links/segments/{segmentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.formbricks.com/api/v2/management/surveys/{surveyId}/contact-links/segments/{segmentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.formbricks.com/api/v2/management/surveys/{surveyId}/contact-links/segments/{segmentId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.formbricks.com/api/v2/management/surveys/{surveyId}/contact-links/segments/{segmentId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.formbricks.com/api/v2/management/surveys/{surveyId}/contact-links/segments/{segmentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"contactId": "<string>",
"surveyUrl": "<string>",
"expiresAt": "<string>",
"attributes": {}
}
],
"meta": {
"total": 123,
"limit": 123,
"offset": 123
}
}Management API - Surveys - Contact Links
Get survey links for contacts in a segment
Generates personalized survey links for contacts in a segment.
GET
/
management
/
surveys
/
{surveyId}
/
contact-links
/
segments
/
{segmentId}
Get survey links for contacts in a segment
curl --request GET \
--url https://app.formbricks.com/api/v2/management/surveys/{surveyId}/contact-links/segments/{segmentId} \
--header 'x-api-key: <api-key>'import requests
url = "https://app.formbricks.com/api/v2/management/surveys/{surveyId}/contact-links/segments/{segmentId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://app.formbricks.com/api/v2/management/surveys/{surveyId}/contact-links/segments/{segmentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.formbricks.com/api/v2/management/surveys/{surveyId}/contact-links/segments/{segmentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.formbricks.com/api/v2/management/surveys/{surveyId}/contact-links/segments/{segmentId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.formbricks.com/api/v2/management/surveys/{surveyId}/contact-links/segments/{segmentId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.formbricks.com/api/v2/management/surveys/{surveyId}/contact-links/segments/{segmentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"contactId": "<string>",
"surveyUrl": "<string>",
"expiresAt": "<string>",
"attributes": {}
}
],
"meta": {
"total": 123,
"limit": 123,
"offset": 123
}
}Authorizations
Use your Formbricks x-api-key to authenticate.
Path Parameters
The ID of the survey
The ID of the segment
Query Parameters
Number of items to return
Required range:
1 <= x <= 250Number of items to skip
Required range:
x >= 0Number of days until the generated JWT expires. If not provided, there is no expiration.
Required range:
1 <= x <= 365Comma-separated list of contact attribute keys to include in the response. You can have max 20 keys. If not provided, no attributes will be included.
Was this page helpful?