Skip to main content
GET
Get a survey

Authorizations

Authorization
string
header
required

Clerk tenant API key. The organizationId encoded by the key is the exact and only tenant scope.

Path Parameters

surveyId
string
required

Response

Tenant-scoped resource.

Sanitized public survey configuration; internal metadata and integration configuration are excluded.

id
string
required
surveyType
string
required
name
string
required
description
string | null
required
isPublished
boolean
required
config
object
required

Allowlisted survey configuration. Webhooks, provider settings, credentials, tokens, workflow payloads, and internal metadata are excluded.

publicUrl
string
required
parentSurveyId
string | null
required
createdAt
string<date-time>
required

UTC ISO 8601 timestamp.

updatedAt
string<date-time>
required

UTC ISO 8601 timestamp.