Getting started
The Responsly API lets your own systems work with your Responsly data: read forms and their responses, keep contacts and contact lists in sync, send surveys, and receive every new response the moment it is saved.
At a glance
Section titled “At a glance”| Base URL | https://api.responsly.com/v1 |
| Authentication | A personal access token in the Authorization: Bearer <token> header. See Authentication. |
| Format | JSON in requests and responses. |
| Pagination | List endpoints return one page at a time. Ask for the next one with the page parameter. |
| Real-time data | Webhooks send each new response to your endpoint, so you do not have to poll. |
Make your first request
Section titled “Make your first request”-
Create a token. In Responsly, open API keys in your profile and create a token. Copy it right away: it is shown only once.
-
Check that it works. Call the test endpoint with the token in the
Authorizationheader:Terminal window curl https://api.responsly.com/v1/test-auth \-H "Authorization: Bearer <token>"The response is the e-mail address of the account the token belongs to:
{ "email": "joe@example.com" } -
List your forms. Get forms returns the forms you can access, with the IDs the other endpoints use.
Explore the API
Section titled “Explore the API” Forms List your forms and the IDs the other endpoints need. Form reference How a form is built: questions, pages, logic, variables and settings. Responses Read the responses to a form, page by page. Webhooks Get every new response pushed to your endpoint. Workspaces List the workspaces of your team and the forms in them. Contact lists Create and manage the lists you send surveys to. Contacts Add, update and remove contacts, one by one or in bulk. Distributions Send a survey to a contact, or create unique survey links. Mobile SDK Show surveys inside iOS, Android, React Native, Flutter and Unity apps.