GET
/
responses
curl --request GET \
  --url https://app.formbricks.com/api/v2/management/responses \
  --header 'x-api-key: <api-key>'
[
  {
    "id": "<string>",
    "createdAt": "2021-01-01T00:00:00.000Z",
    "updatedAt": "2021-01-01T00:00:00.000Z",
    "finished": true,
    "surveyId": "<string>",
    "contactId": "<string>",
    "endingId": "<string>",
    "data": {
      "question1": "answer1",
      "question2": 2,
      "question3": [
        "answer3",
        "answer4"
      ],
      "question4": {
        "subquestion1": "answer5"
      }
    },
    "variables": {
      "variable1": "answer1",
      "variable2": 2
    },
    "ttc": {
      "question1": 10,
      "question2": 20
    },
    "meta": {
      "source": "https://example.com",
      "url": "https://example.com",
      "userAgent": {
        "browser": "Chrome",
        "os": "Windows",
        "device": "Desktop"
      },
      "country": "US",
      "action": "click"
    },
    "contactAttributes": {
      "attribute1": "value1",
      "attribute2": "value2"
    },
    "singleUseId": "<string>",
    "language": "en",
    "displayId": "<string>"
  }
]

Authorizations

​
x-api-key
string
header
required

Use your Formbricks x-api-key to authenticate.

Query Parameters

​
limit
number
default:10
Required range: 1 <= x <= 100
​
skip
number
default:0
Required range: x >= 0
​
sortBy
enum<string>
default:createdAt
Available options:
createdAt,
updatedAt
​
order
enum<string>
default:desc
Available options:
asc,
desc
​
startDate
string
required
​
endDate
string
required
​
surveyId
string
required
​
contactId
string
required

Response

200 - application/json
Responses retrieved successfully.
​
id
string
required

The ID of the response

​
createdAt
string
required

The date and time the response was created

Example:

"2021-01-01T00:00:00.000Z"

​
updatedAt
string
required

The date and time the response was last updated

Example:

"2021-01-01T00:00:00.000Z"

​
finished
boolean
required

Whether the response is finished

Example:

true

​
surveyId
string
required

The ID of the survey

​
contactId
string | null
required

The ID of the contact

​
endingId
string | null
required

The ID of the ending

​
data
object
required

The data of the response

Example:
{
  "question1": "answer1",
  "question2": 2,
  "question3": ["answer3", "answer4"],
  "question4": { "subquestion1": "answer5" }
}
​
variables
object
required

The variables of the response

Example:
{ "variable1": "answer1", "variable2": 2 }
​
ttc
object
required

The TTC of the response

Example:
{ "question1": 10, "question2": 20 }
​
meta
object
required

The meta data of the response

Example:
{
  "source": "https://example.com",
  "url": "https://example.com",
  "userAgent": {
    "browser": "Chrome",
    "os": "Windows",
    "device": "Desktop"
  },
  "country": "US",
  "action": "click"
}
​
contactAttributes
object | null
required

The attributes of the contact

Example:
{
  "attribute1": "value1",
  "attribute2": "value2"
}
​
singleUseId
string | null
required

The single use ID of the response

​
language
string | null
required

The language of the response

Example:

"en"

​
displayId
string | null
required

The display ID of the response

Was this page helpful?