/surveys/templates

Changed on

Returns the account's survey master templates. 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.

Only the latest, non-deleted master templates in the survey category are returned. Pagination is optional via limit and offset; when omitted every template is returned.

get/surveys/templates

Request

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

Query parameters

limitinteger

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

offsetinteger

Number of templates to skip (for pagination).

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