WOworkable

/surveys/:id

Changed on

Returns a single survey cycle by its key. 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.

Deleted survey cycles, and survey cycles outside a scoped member's scope, return 404.

get/surveys/{id}

Request

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

Path parameters

idstring required

Survey cycle key (as returned by GET /surveys)

Query parameters

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

idstring

Survey cycle key

namestring
welcome_messagestring nullable

Welcome message shown to participants (HTML)

state'draft' | 'scheduled' | 'active' | 'closed' | 'archived'
type'cycle' | 'workflow_task' | 'null' nullable

cycle = date-based survey, workflow_task = survey sent as a workflow task

template_idstring nullable

Survey master template id

start_datestring date-time nullable
end_datestring date-time nullable
timezonestring nullable

IANA timezone

is_anonymousboolean
min_responses_requiredinteger

Anonymity threshold; 0 = none

participant_countinteger
employee_sharing_type'all' | 'selected' | 'custom' | 'null' nullable
created_atstring date-time
updated_atstring date-time

Changes