WOworkable

/surveys/:id/answers

Changed on

Returns the individual submitted answers of a survey cycle. Required scope: r_surveys. Requires a user token whose member has permission to view survey cycles, or an account token with the member_id of such a member; an account token without member_id gets 403. The account must have the Surveys feature enabled.

Non-anonymous surveys include the participant identity (employee), employee_survey_id and submitted_at. Anonymous surveys return only id, question_id, question_type, answer and choices, and when min_responses_required > 0 answers are withheld until the threshold is met overall and per question (withheld answers still count towards total_count). Members with a scoped role only receive answers of employees within their scope. Ordered by participant last name, first name, then answer id.

get/surveys/{id}/answers

Request

  • Base URL
    https://subdomain.workable.com/spi/v3
  • URL
    https://subdomain.workable.com/spi/v3/surveys/{id}/answers
  • Auth
    API key in header Authorization

Path parameters

idstring required

Survey cycle key (as returned by GET /surveys)

Query parameters

limitinteger

Maximum number of answers to return.

offsetinteger

Number of answers to skip (for pagination).

question_ids[]string[]

Restrict the answers to these question ids. Ids not in the survey's questionnaire are ignored.

member_idstring

Required when using an account token: the member (SPI key, from GET /members) to act as. The request is evaluated with that member's permissions; without it the request gets 403. Ignored for user tokens.

Response

200

total_countinteger

Changes