Skip to content
SurveyRock Support

Get draft status

GET
/surveys/{id}/draft/status
curl --request GET \
  --url https://app.surveyrock.com/api/v1/surveys/example/draft/status \
  --header 'Authorization: Bearer <token>'

Returns the current draft status for a survey, including publish status and timestamps.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Survey ID

Responses

Section titled “Responses”

200

Section titled “200”

Draft status

Media typeapplication/json
object
success
boolean
data
object
status
string
Allowed values: never_published published unpublished_changes
lastPublished
string format: date-time
nullable
draftModifiedAt
string format: date-time
nullable
currentLiveVersion
integer
nullable
hasUnpublishedChanges
boolean
meta

Standard response metadata

object
timestamp

Response timestamp in ISO 8601 format

string format: date-time
version

API version

string
requestId

Unique request identifier

string
Example
{
  "success": true,
  "data": {
    "status": "never_published"
  },
  "meta": {
    "version": "3.0"
  }
}

404

Section titled “404”

Survey not found

Media typeapplication/json

Standard error response format

object
success
boolean
error
object
code

Stable, snake_case domain code – see ApiErrorHandler::EXCEPTION_MAP and DomainException

string
message

Human-readable error message

string
suggestion

Imperative recovery hint for this domain code – see ApiErrorHandler::DOMAIN_CODE_SUGGESTIONS

string
retryable

Whether retrying the identical request might succeed without any change on the caller’s end

boolean
details

Additional, code-specific error details

object
meta

Standard response metadata

object
timestamp

Response timestamp in ISO 8601 format

string format: date-time
version

API version

string
requestId

Unique request identifier

string
Example
{
  "success": false,
  "error": {
    "code": "survey_not_found"
  },
  "meta": {
    "version": "3.0"
  }
}