WOworkable

/surveys

Changed on

Returns the account's survey cycles. 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 are never returned. Members with a scoped role only see survey cycles within their scope plus any they participate in. Results are ordered by id. Pagination is optional via limit and offset; when omitted every survey cycle is returned.

get/surveys

Request

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

Query parameters

limitinteger

Maximum number of survey cycles to return. When omitted, all matching survey cycles are returned.

offsetinteger

Number of survey cycles to skip (for pagination).

states[]string[]

Filter by one or more states. Defaults to all of draft, scheduled, active, closed, archived.

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

Example response

{
  "total_count": 1
}

Changes