Skip to content
SurveyRock Support

Get NPS response

GET
/nps/{id}/response
curl --request GET \
  --url 'https://app.surveyrock.com/api/v1/nps/example/response?respondentId=example' \
  --header 'Authorization: Bearer <token>'

Get an existing NPS response for a respondent

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string
>= 16 characters <= 16 characters

NPS element ID

Query Parameters

Section titled “Query Parameters”
respondentId
required
string
>= 16 characters <= 16 characters

Respondent ID

Responses

Section titled “Responses”

200

Section titled “200”

NPS response data or null if not found

Media typeapplication/json
object
success
boolean
data
object
value
integer
type
string
recommendationSubject
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,
  "data": {
    "type": "nps"
  },
  "meta": {
    "version": "3.0"
  }
}

400

Section titled “400”

Bad request - missing respondentId

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
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": false,
  "error": {
    "code": "survey_not_found"
  },
  "meta": {
    "version": "3.0"
  }
}