Sprig Surveys API
The Surveys API from Sprig — 1 operation(s) for surveys.
The Surveys API from Sprig — 1 operation(s) for surveys.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/sprig:sprig-surveys-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
contact:
email: support@sprig.com
name: Support
description: Sprig is a continuous product research tool that helps you automatically capture the user insights you need to consistently improve your product, user experience, marketing, and more.
title: Sprig Surveys API
version: 2.2.1
servers:
- url: https://api.sprig.com
tags:
- name: Surveys
paths:
/v1/surveys:
get:
description: Studies were formerly surveys. This endpoint allows for the export of study configurations. The name will eventually change to Study, but at this time survey will be accepted anywhere study appears in the API. This endpoint allows you retrieve up to 1000 surveys at a time.
operationId: get-v1-surveys
parameters:
- $ref: '#/components/parameters/start'
- $ref: '#/components/parameters/end'
- $ref: '#/components/parameters/cursor'
- $ref: '#/components/parameters/status'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/Authorization-Bearer'
responses:
'200':
content:
application/json:
examples:
example surveys:
value:
cursor: Y3JlYXRlZEF0OjE1NTMyMDAxNTMwMTk=
data:
- completedAt: '2019-06-12T19:23:35.522Z'
constraints:
- comparisonType: gte
event: null
type: SESSION_COUNT
value: 1
- comparisonType: eq
event: null
type: TIME_ON_PAGE_DELAY
value: 2
createdAt: '2018-07-18T08:02:09.858Z'
id: 12
launchedAt: null
name: Understand Appeal
platform: web
questions:
- id: 118
options: []
optionsProperties:
introText: Thanks for using Sprig. Tell us about your experience.
labels:
left: Not at all interested
right: Extremely interested
questionText: How interested are you in using Sprig?
routingOptions: null
type: LIKERT
- id: 105
options: []
optionsProperties: null
questionText: What aspect of Sprig is most appealing?
routingOptions: null
type: OPEN
status: COMPLETED
totalResponseLimit: null
type: CONTINUOUS
updatedAt: '2019-06-12T19:23:35.522Z'
schema:
description: ''
properties:
cursor:
minLength: 1
type: string
data:
items:
properties:
completedAt:
minLength: 1
type: string
constraints:
items:
properties:
comparisonType:
minLength: 1
type: string
event: {}
type:
minLength: 1
type: string
value:
type: number
type: object
minItems: 1
type: array
uniqueItems: true
createdAt:
minLength: 1
type: string
id:
type: number
launchedAt: {}
name:
minLength: 1
type: string
platform:
minLength: 1
type: string
questions:
items:
properties:
id:
type: number
options:
items:
type: object
type: array
optionsProperties:
nullable: true
properties:
introText:
minLength: 1
type: string
labels:
properties:
left:
minLength: 1
type: string
right:
minLength: 1
type: string
required:
- left
- right
type: object
type: object
questionText:
minLength: 1
type: string
routingOptions: {}
type:
minLength: 1
type: string
type: object
minItems: 1
type: array
uniqueItems: true
status:
minLength: 1
type: string
totalResponseLimit: {}
type:
minLength: 1
type: string
updatedAt:
minLength: 1
type: string
type: object
minItems: 1
type: array
uniqueItems: true
type: object
x-examples:
example-1:
cursor: Y3JlYXRlZEF0OjE1NTMyMDAxNTMwMTk=
data:
- completedAt: '2019-06-12T19:23:35.522Z'
constraints:
- comparisonType: gte
event: null
type: SESSION_COUNT
value: 1
- comparisonType: eq
event: null
type: TIME_ON_PAGE_DELAY
value: 2
createdAt: '2018-07-18T08:02:09.858Z'
id: 12
launchedAt: null
name: Understand Appeal
platform: web
questions:
- id: 118
options: []
optionsProperties:
introText: Thanks for using Sprig. Tell us about your experience.
labels:
left: Not at all interested
right: Extremely interested
questionText: How interested are you in using Sprig?
routingOptions: null
type: LIKERT
- id: 105
options: []
optionsProperties: null
questionText: What aspect of Sprig is most appealing?
routingOptions: null
type: OPEN
status: COMPLETED
totalResponseLimit: null
type: CONTINUOUS
updatedAt: '2019-06-12T19:23:35.522Z'
description: OK
'400':
$ref: '#/components/responses/400'
'403':
$ref: '#/components/responses/403'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
summary: Retrieve Surveys
tags:
- Surveys
components:
responses:
'500':
description: Something went wrong on Sprig's side. These are very rare :)
'403':
description: You may have an invalid or missing API key and you should check your authorization header. There is no message with this status code.
'400':
content:
application/json:
schema:
properties:
error:
type: string
description: Bad Request
'429':
description: Your application has made too many requests in too short a time.
parameters:
start:
description: The earliest creation data for a generated theme to return, represented as milliseconds from epoch time
in: query
name: start
required: false
schema:
type: integer
status:
description: One or many of (IN_PROGRESS, PAUSED, COMPLETED, DRAFT, ARCHIVED, NEW). Can be passed as ?status=PAUSED,COMPLETED, ?status[]=PAUSED&status[]=COMPLETED or ?status=PAUSED&status=COMPLETED
in: query
name: status
required: false
schema:
items:
enum:
- IN_PROGRESS
- PAUSED
- COMPLETED
- DRAFT
- ARCHIVED
- NEW
type: string
type: array
end:
description: The latest creation date for a generated theme to return, represented as milleseconds from epoch time
in: query
name: end
required: false
schema:
type: integer
limit:
description: Specific number of results to return
in: query
name: limit
required: false
schema:
maximum: 1000
minimum: 1
type: integer
Authorization-Bearer:
description: Bearer YOUR_API_KEY
in: header
name: Authorization
required: true
schema:
type: string
cursor:
description: A Base64 encoded string representing an opaque cursor position
in: query
name: cursor
required: false
schema:
type: string
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: Authorization
description: Use `API-Key YOUR_API_KEY` for v2 endpoints or `Bearer YOUR_API_KEY` for export endpoints.
x-readme:
explorer-enabled: true
proxy-enabled: true
samples-enabled: true