Results
Get a result
Results
Get a result
GET
/
v1
/
typebots
/
{typebotId}
/
results
/
{resultId}
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
typebotId
string
*
typebotId
Required
string
resultId
string
*
resultId
Required
string
The resultId
is returned by the /startChat endpoint or you can find it by listing results with /results
endpoint
curl --request GET \
--url https://app.typebot.io/api/v1/typebots/{typebotId}/results/{resultId} \
--header 'Authorization: Bearer <token>'
{
"result": {
"id": "<string>",
"createdAt": "<string>",
"typebotId": "<string>",
"variables": [
{
"id": "<string>",
"name": "<string>",
"isSessionVariable": true,
"value": "<string>"
}
],
"isCompleted": true,
"hasStarted": true,
"isArchived": true,
"answers": [
{
"createdAt": "<string>",
"resultId": "<string>",
"blockId": "<string>",
"groupId": "<string>",
"variableId": "<string>",
"content": "<string>",
"storageUsed": 123
}
]
}
}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
typebotId
string
requiredresultId
string
requiredThe resultId
is returned by the /startChat endpoint or you can find it by listing results with /results
endpoint
Response
200 - application/json
result
object
requiredresult.id
string
requiredresult.createdAt
string
requiredresult.typebotId
string
requiredresult.variables
object[]
requiredresult.variables.id
string
requiredresult.variables.name
string
requiredresult.variables.isSessionVariable
boolean
result.variables.value
required
result.isCompleted
boolean
requiredresult.hasStarted
boolean | null
requiredresult.isArchived
boolean | null
requiredresult.answers
object[]
requiredresult.answers.createdAt
string
requiredresult.answers.resultId
string
requiredresult.answers.blockId
string
requiredresult.answers.groupId
string
requiredresult.answers.variableId
string | null
requiredresult.answers.content
string
requiredresult.answers.storageUsed
number | null
requiredcurl --request GET \
--url https://app.typebot.io/api/v1/typebots/{typebotId}/results/{resultId} \
--header 'Authorization: Bearer <token>'
{
"result": {
"id": "<string>",
"createdAt": "<string>",
"typebotId": "<string>",
"variables": [
{
"id": "<string>",
"name": "<string>",
"isSessionVariable": true,
"value": "<string>"
}
],
"isCompleted": true,
"hasStarted": true,
"isArchived": true,
"answers": [
{
"createdAt": "<string>",
"resultId": "<string>",
"blockId": "<string>",
"groupId": "<string>",
"variableId": "<string>",
"content": "<string>",
"storageUsed": 123
}
]
}
}