Skip to content

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.

Base URLhttps://api.responsly.com/v1
AuthenticationA personal access token in the Authorization: Bearer <token> header. See Authentication.
FormatJSON in requests and responses.
PaginationList endpoints return one page at a time. Ask for the next one with the page parameter.
Real-time dataWebhooks send each new response to your endpoint, so you do not have to poll.
  1. Create a token. In Responsly, open API keys in your profile and create a token. Copy it right away: it is shown only once.

  2. Check that it works. Call the test endpoint with the token in the Authorization header:

    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" }
  3. List your forms. Get forms returns the forms you can access, with the IDs the other endpoints use.