Get survey links for contacts in a segment

Authorization

apiKeyAuth

x-api-key<token>

Use your SurveyTale x-api-key to authenticate.

In: header

Path Parameters

surveyId*string

The ID of the survey

Match^[0-9a-z]+$

Formatcuid2

segmentId*string

The ID of the segment

Match^[0-9a-z]+$

Formatcuid2

Query Parameters

limit?number

Number of items to return

Default50

Range1 <= value <= 250

skip?number

Number of items to skip

Range0 <= value

expirationDays?|

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

attributeKeys?string

Comma-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.

Response Body

`application/json`

curl -X GET "https://example.com/management/surveys/string/contact-links/segments/string"

{
  "data": [
    {
      "contactId": "string",
      "surveyUrl": "http://example.com",
      "expiresAt": "string",
      "attributes": {
        "property1": "string",
        "property2": "string"
      }
    }
  ],
  "meta": {
    "total": 0,
    "limit": 0,
    "offset": 0
  }
}