SurveyOL API Overview

This docs folder is aligned with the API reference shown on the SurveyOL developer page.

Base URL

https://api.surveyol.com/v1

Authentication

SurveyOL API uses OAuth 2.0 with bearer tokens.

Generate your access token from My Account, then send it in headers:

Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json

Format

• Request parameters are JSON.
• Responses are JSON.

Scope

The documented objects are:

• Account
• Contacts
• Surveys
• Collectors
• Responses

Rate Limit

• 10 calls per minute
• 1,000 calls per day

Contact support for additional capacity.

Documentation Index

• Authentication
• AI Index
• Create Survey
• Update Survey
• Publish Survey Guidance
• Email Invitations
• Anonymous Links
• QR Codes
• Mobile SMS
• Get Results
• Export Results
• Analytics
• Survey JSON Shape
• Question Types
• Employee Feedback Example
• Customer Satisfaction Example

Endpoint Matrix

Account

• POST /account/me
• GET /account/me

Contacts

• POST /contact
• DELETE /contact/{contactId}
• GET /contacts
• POST /contact/{contactId}
• GET /contact/{contactId}

Surveys

• POST /survey
• POST /survey/{surveyId}/page
• POST /page/{pageId}/question
• POST /survey/{surveyId}/copy
• DELETE /survey/{surveyId}
• DELETE /page/{pageId}
• DELETE /question/{questionId}
• GET /surveys
• GET /survey/{surveyId}/pages
• GET /page/{pageId}/questions
• POST /survey/{surveyId}
• POST /page/{pageId}
• POST /question/{questionId}
• GET /survey/{surveyId}
• GET /page/{pageId}
• GET /question/{questionId}

Collectors

• POST /survey/{surveyId}/collector
• DELETE /collector/{collectorId}
• GET /survey/{surveyId}/collectors
• POST /collector/{collectorId}
• GET /collector/{collectorId}

Responses

• POST /survey/{surveyId}/response
• DELETE /response/{responseId}
• GET /survey/{surveyId}/responses
• GET /response/{responseId}