Skip to content
Asqiro

Asqiro Public API v1

Read your surveys, export responses, subscribe to response events, and open a survey for a signed-in user of your own product. Every endpoint is authenticated with a workspace API key and answers JSON.

Service endpoint

All paths below are relative to this base URL. Requests must use HTTPS.

text
https://www.asqiro.com

Authentication

Send your key as a bearer token. A key acts as the user who created it, inside one workspace.

http
Authorization: Bearer asq_your_key_here

Your first request

Create a key in Settings, then list the surveys in its workspace.

bash
curl "https://www.asqiro.com/api/v1/surveys" \
  -H "Authorization: Bearer $ASQIRO_API_KEY"

A successful call returns a page of surveys and a nextCursor you can follow to read the rest.

What you can call

Each resource below has a reference page with its parameters, response fields, and errors.

  • Surveys

    Read the surveys in the API key's workspace. 2 endpoints

  • Questions

    Read the question definitions that answers refer to. 1 endpoints

  • Responses

    Read and export the responses collected by a survey. 2 endpoints

  • Analytics

    Read the aggregated results of a survey. 1 endpoints

  • Survey webhook

    Configure where one survey sends its events, and read what it delivered. 5 endpoints

  • Workspace webhook

    One endpoint that receives events from every survey in the workspace. 5 endpoints

  • Embed sessions

    Open a published survey inside your product for a user you already identify. 1 endpoints

  • Usage

    Read the request quota your key is spending. 1 endpoints

Discovery document

The same contract is published as an OpenAPI 3.1 document. Import it into an HTTP client or feed it to a code generator instead of transcribing these pages by hand. It is generated from the source these pages render, so it never describes a different API.

/api/v1/openapi.jsonOpen the OpenAPI document

What v1 does not do yet

Public API v1 is read-oriented. You can read surveys and responses, and manage a survey's webhook and embed sessions. Creating or editing survey content over the API is not available, and no endpoint returns respondent identity beyond the externalUserId you supply yourself.