Get lock status

GET

/surveys/{id}/lock/status

const url = 'https://app.surveyrock.com/api/v1/surveys/example/lock/status';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Returns the current lock status for a survey, including who holds the lock and when it was acquired.

Authorizations

bearerAuth
surveys:read

Parameters

Path Parameters

required

string

Survey ID

Responses

200

Lock status

application/json

object

success

boolean

data

object

locked

boolean

lockedBy

string

nullable

lockedAt

string format: date-time

nullable

expiresAt

string format: date-time

nullable

lockReason

string

nullable

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

etag

The resource’s ETag, on a read, create or update of a survey, element, rating or NPS question, distributor or contact. The same value as the ETag response header. Treat it as opaque and send it back as If-Match on the next update.

string

Example

{
  "success": true,
  "meta": {
    "version": "3.0"
  }
}

404

Survey not found

application/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

etag

string

Example

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