Get responses

Gets responses from the database.

Authorizations

x-api-key

string

header

required

Use your Formbricks x-api-key to authenticate.

Query Parameters

limit

number

default:50

Number of items to return

Required range: 1 <= x <= 250

skip

number

default:0

Number of items to skip

Required range: x >= 0

sortBy

enum<string>

default:createdAt

Sort by field

Available options:

createdAt,

updatedAt

order

enum<string>

default:desc

Sort order

Available options:

asc,

desc

startDate

string

Start date

endDate

string

End date

surveyId

string

contactId

string

Response

200 - application/json

Responses retrieved successfully.

data

object[]

Show child attributes

data.id

string

The ID of the response

data.createdAt

string

The date and time the response was created

Example:

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

data.updatedAt

string

The date and time the response was last updated

Example:

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

data.finished

boolean

Whether the response is finished

Example:

true

data.surveyId

string

The ID of the survey

data.contactId

string | null

The ID of the contact

data.endingId

string | null

The ID of the ending

data.data

object

The data of the response

Show child attributes

data.data.{key}

Example:

{
  "question1": "answer1",
  "question2": 2,
  "question3": ["answer3", "answer4"],
  "question4": { "subquestion1": "answer5" }
}

data.variables

object

The variables of the response

Show child attributes

data.variables.{key}

Example:

{ "variable1": "answer1", "variable2": 2 }

data.ttc

object

The TTC of the response

Show child attributes

data.ttc.{key}

number

Example:

{ "question1": 10, "question2": 20 }

data.meta

object

The meta data of the response

Show child attributes

data.meta.source

string

The source of the response

Example:

"https://example.com"

data.meta.url

string

The URL of the response

Example:

"https://example.com"

data.meta.userAgent

object

Show child attributes

data.meta.userAgent.browser

string

data.meta.userAgent.os

string

data.meta.userAgent.device

string

data.meta.country

string

data.meta.action

string

Example:

{
  "source": "https://example.com",
  "url": "https://example.com",
  "userAgent": {
    "browser": "Chrome",
    "os": "Windows",
    "device": "Desktop"
  },
  "country": "US",
  "action": "click"
}

data.contactAttributes

object | null

The attributes of the contact

Show child attributes

data.contactAttributes.{key}

string

Example:

{
  "attribute1": "value1",
  "attribute2": "value2"
}

data.singleUseId

string | null

The single use ID of the response

data.language

string | null

The language of the response

Example:

"en"

data.displayId

string | null

The display ID of the response

meta

object

Show child attributes

meta.total

number

meta.limit

number

meta.offset

number