SurveyTale API Docs

Authorization

apiKeyAuth

x-api-key<token>

Use your SurveyTale x-api-key to authenticate.

In: header

Query Parameters

limit?number

Number of items to return

Default50

Range1 <= value <= 250

skip?number

Number of items to skip

Range0 <= value

sortBy?string

Sort by field

Default"createdAt"

Value in"createdAt" | "updatedAt"

order?string

Sort order

Default"desc"

Value in"asc" | "desc"

startDate?string

Start date

endDate?string

End date

filterDateField?string

Date field to filter by

Value in"createdAt" | "updatedAt"

surveyIds?array<>

Response Body

`application/json`

curl -X GET "https://example.com/management/webhooks"

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "createdAt": "2021-01-01T00:00:00.000Z",
      "updatedAt": "2021-01-01T00:00:00.000Z",
      "url": "http://example.com",
      "source": "user",
      "workspaceId": "string",
      "triggers": [
        "responseFinished"
      ],
      "surveyIds": [
        "string"
      ],
      "secret": "string"
    }
  ],
  "meta": {
    "total": 0,
    "limit": 0,
    "offset": 0
  }
}

Get webhooks

Authorization

Query Parameters

Response Body

200application/json

`application/json`