Typebot
Get a typebot
Typebot
Get a typebot
GET
/
v1
/
typebots
/
{typebotId}
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
migrateToLatestVersion
boolean
migrateToLatestVersion
boolean
If enabled, the typebot will be converted to the latest schema version
curl --request GET \
--url https://app.typebot.io/api/v1/typebots/{typebotId} \
--header 'Authorization: Bearer <token>'
{
"typebot": {
"version": "6",
"id": "<string>",
"name": "<string>",
"events": [
{
"id": "<string>",
"outgoingEdgeId": "<string>",
"graphCoordinates": {
"x": 123,
"y": 123
},
"type": "start"
}
],
"groups": [
{
"id": "<string>",
"title": "<string>",
"graphCoordinates": {
"x": 123,
"y": 123
},
"blocks": [
{
"id": "<string>",
"outgoingEdgeId": "<string>",
"type": "text",
"content": {
"html": "<string>",
"richText": [
"<any>"
],
"plainText": "<string>"
}
}
]
}
],
"edges": [
{
"id": "<string>",
"from": {
"blockId": "<string>",
"itemId": "<string>"
},
"to": {
"groupId": "<string>",
"blockId": "<string>"
}
}
],
"variables": [
{
"id": "<string>",
"name": "<string>",
"isSessionVariable": true,
"value": "<string>"
}
],
"theme": {
"general": {
"font": "<string>",
"background": {
"type": "Color",
"content": "<string>"
},
"progressBar": {
"isEnabled": true,
"color": "<string>",
"backgroundColor": "<string>",
"placement": "Top",
"thickness": 123,
"position": "fixed"
}
},
"chat": {
"container": {
"maxWidth": "<string>",
"maxHeight": "<string>",
"backgroundColor": "<string>",
"color": "<string>",
"blur": 123,
"opacity": 0.5,
"shadow": "none",
"border": {
"thickness": 123,
"color": "<string>",
"roundeness": "none",
"customRoundeness": 123,
"opacity": 0.5
}
},
"hostAvatar": {
"isEnabled": true,
"url": "<string>"
},
"guestAvatar": {
"isEnabled": true,
"url": "<string>"
},
"hostBubbles": {
"backgroundColor": "<string>",
"color": "<string>",
"blur": 123,
"opacity": 0.5,
"shadow": "none",
"border": {
"thickness": 123,
"color": "<string>",
"roundeness": "none",
"customRoundeness": 123,
"opacity": 0.5
}
},
"guestBubbles": {
"backgroundColor": "<string>",
"color": "<string>",
"blur": 123,
"opacity": 0.5,
"shadow": "none",
"border": {
"thickness": 123,
"color": "<string>",
"roundeness": "none",
"customRoundeness": 123,
"opacity": 0.5
}
},
"buttons": {
"backgroundColor": "<string>",
"color": "<string>",
"blur": 123,
"opacity": 0.5,
"shadow": "none",
"border": {
"thickness": 123,
"color": "<string>",
"roundeness": "none",
"customRoundeness": 123,
"opacity": 0.5
}
},
"inputs": {
"backgroundColor": "<string>",
"color": "<string>",
"blur": 123,
"opacity": 0.5,
"shadow": "none",
"border": {
"thickness": 123,
"color": "<string>",
"roundeness": "none",
"customRoundeness": 123,
"opacity": 0.5
},
"placeholderColor": "<string>"
},
"roundness": "none"
},
"customCss": "<string>"
},
"selectedThemeTemplateId": "<string>",
"settings": {
"general": {
"isBrandingEnabled": true,
"isTypingEmulationEnabled": true,
"isInputPrefillEnabled": true,
"isHideQueryParamsEnabled": true,
"isNewResultOnRefreshEnabled": true,
"rememberUser": {
"isEnabled": true,
"storage": "session"
}
},
"typingEmulation": {
"enabled": true,
"speed": 123,
"maxDelay": 123,
"delayBetweenBubbles": 2.5,
"isDisabledOnFirstMessage": true
},
"metadata": {
"title": "<string>",
"description": "<string>",
"imageUrl": "<string>",
"favIconUrl": "<string>",
"customHeadCode": "<string>",
"googleTagManagerId": "<string>"
},
"whatsApp": {
"isEnabled": true,
"startCondition": {
"logicalOperator": "OR",
"comparisons": [
{
"id": "<string>",
"comparisonOperator": "Equal to",
"value": "<string>"
}
]
},
"sessionExpiryTimeout": 24.005
},
"publicShare": {
"isEnabled": true
},
"security": {
"allowedOrigins": [
"<string>"
]
}
},
"createdAt": "<string>",
"updatedAt": "<string>",
"icon": "<string>",
"folderId": "<string>",
"publicId": "<string>",
"customDomain": "<string>",
"workspaceId": "<string>",
"resultsTablePreferences": {
"columnsOrder": [
"<string>"
],
"columnsVisibility": {},
"columnsWidth": {}
},
"isArchived": true,
"isClosed": true,
"whatsAppCredentialsId": "<string>",
"riskLevel": 123
},
"currentUserMode": "guest"
}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
typebotId
string
requiredQuery Parameters
migrateToLatestVersion
boolean
default: falseIf enabled, the typebot will be converted to the latest schema version
Response
200 - application/json
typebot
object
requiredtypebot.version
enum<string>
requiredAvailable options:
6
typebot.id
string
requiredtypebot.name
string
requiredtypebot.events
object[]
requiredtypebot.events.id
string
requiredtypebot.events.outgoingEdgeId
string
typebot.events.graphCoordinates
object
requiredtypebot.events.graphCoordinates.x
number
requiredtypebot.events.graphCoordinates.y
number
requiredtypebot.events.type
enum<string>
requiredAvailable options:
start
typebot.groups
object[]
requiredtypebot.groups.id
string
requiredtypebot.groups.title
string
requiredtypebot.groups.graphCoordinates
object
requiredtypebot.groups.graphCoordinates.x
number
requiredtypebot.groups.graphCoordinates.y
number
requiredtypebot.groups.blocks
object[]
requiredtypebot.groups.blocks.id
string
requiredtypebot.groups.blocks.outgoingEdgeId
string
typebot.groups.blocks.type
enum<string>
requiredAvailable options:
text
typebot.groups.blocks.content
object
typebot.groups.blocks.content.html
string
typebot.groups.blocks.content.richText
any[]
typebot.groups.blocks.content.plainText
string
typebot.edges
object[]
requiredtypebot.edges.id
string
requiredtypebot.edges.from
object
requiredtypebot.edges.from.blockId
string
requiredtypebot.edges.from.itemId
string
typebot.edges.to
object
requiredtypebot.edges.to.groupId
string
requiredtypebot.edges.to.blockId
string
typebot.variables
object[]
requiredtypebot.variables.id
string
requiredtypebot.variables.name
string
requiredtypebot.variables.isSessionVariable
boolean
typebot.variables.value
typebot.theme
object
requiredtypebot.theme.general
object
typebot.theme.general.font
typebot.theme.general.background
object
typebot.theme.general.background.type
enum<string>
Available options:
Color
, Image
, None
typebot.theme.general.background.content
string
typebot.theme.general.progressBar
object
typebot.theme.general.progressBar.isEnabled
boolean
typebot.theme.general.progressBar.color
string
typebot.theme.general.progressBar.backgroundColor
string
typebot.theme.general.progressBar.placement
enum<string>
Available options:
Top
, Bottom
typebot.theme.general.progressBar.thickness
number
typebot.theme.general.progressBar.position
enum<string>
Available options:
fixed
, absolute
typebot.theme.chat
object
typebot.theme.chat.container
object
typebot.theme.chat.container.maxWidth
string
typebot.theme.chat.container.maxHeight
string
typebot.theme.chat.container.backgroundColor
string
typebot.theme.chat.container.color
string
typebot.theme.chat.container.blur
number
typebot.theme.chat.container.opacity
number
typebot.theme.chat.container.shadow
enum<string>
Available options:
none
, sm
, md
, lg
, xl
, 2xl
typebot.theme.chat.container.border
object
typebot.theme.chat.container.border.thickness
number
typebot.theme.chat.container.border.color
string
typebot.theme.chat.container.border.roundeness
enum<string>
Available options:
none
, medium
, large
, custom
typebot.theme.chat.container.border.customRoundeness
number
typebot.theme.chat.container.border.opacity
number
typebot.theme.chat.hostAvatar
object
typebot.theme.chat.hostAvatar.isEnabled
boolean
typebot.theme.chat.hostAvatar.url
string
typebot.theme.chat.guestAvatar
object
typebot.theme.chat.guestAvatar.isEnabled
boolean
typebot.theme.chat.guestAvatar.url
string
typebot.theme.chat.hostBubbles
object
typebot.theme.chat.hostBubbles.backgroundColor
string
typebot.theme.chat.hostBubbles.color
string
typebot.theme.chat.hostBubbles.blur
number
typebot.theme.chat.hostBubbles.opacity
number
typebot.theme.chat.hostBubbles.shadow
enum<string>
Available options:
none
, sm
, md
, lg
, xl
, 2xl
typebot.theme.chat.hostBubbles.border
object
typebot.theme.chat.hostBubbles.border.thickness
number
typebot.theme.chat.hostBubbles.border.color
string
typebot.theme.chat.hostBubbles.border.roundeness
enum<string>
Available options:
none
, medium
, large
, custom
typebot.theme.chat.hostBubbles.border.customRoundeness
number
typebot.theme.chat.hostBubbles.border.opacity
number
typebot.theme.chat.guestBubbles
object
typebot.theme.chat.guestBubbles.backgroundColor
string
typebot.theme.chat.guestBubbles.color
string
typebot.theme.chat.guestBubbles.blur
number
typebot.theme.chat.guestBubbles.opacity
number
typebot.theme.chat.guestBubbles.shadow
enum<string>
Available options:
none
, sm
, md
, lg
, xl
, 2xl
typebot.theme.chat.guestBubbles.border
object
typebot.theme.chat.guestBubbles.border.thickness
number
typebot.theme.chat.guestBubbles.border.color
string
typebot.theme.chat.guestBubbles.border.roundeness
enum<string>
Available options:
none
, medium
, large
, custom
typebot.theme.chat.guestBubbles.border.customRoundeness
number
typebot.theme.chat.guestBubbles.border.opacity
number
typebot.theme.chat.buttons
object
typebot.theme.chat.buttons.backgroundColor
string
typebot.theme.chat.buttons.color
string
typebot.theme.chat.buttons.blur
number
typebot.theme.chat.buttons.opacity
number
typebot.theme.chat.buttons.shadow
enum<string>
Available options:
none
, sm
, md
, lg
, xl
, 2xl
typebot.theme.chat.buttons.border
object
typebot.theme.chat.buttons.border.thickness
number
typebot.theme.chat.buttons.border.color
string
typebot.theme.chat.buttons.border.roundeness
enum<string>
Available options:
none
, medium
, large
, custom
typebot.theme.chat.buttons.border.customRoundeness
number
typebot.theme.chat.buttons.border.opacity
number
typebot.theme.chat.inputs
object
typebot.theme.chat.inputs.backgroundColor
string
typebot.theme.chat.inputs.color
string
typebot.theme.chat.inputs.blur
number
typebot.theme.chat.inputs.opacity
number
typebot.theme.chat.inputs.shadow
enum<string>
Available options:
none
, sm
, md
, lg
, xl
, 2xl
typebot.theme.chat.inputs.border
object
typebot.theme.chat.inputs.border.thickness
number
typebot.theme.chat.inputs.border.color
string
typebot.theme.chat.inputs.border.roundeness
enum<string>
Available options:
none
, medium
, large
, custom
typebot.theme.chat.inputs.border.customRoundeness
number
typebot.theme.chat.inputs.border.opacity
number
typebot.theme.chat.inputs.placeholderColor
string
typebot.theme.chat.roundness
enum<string>
Deprecated, use container.border.roundeness
instead
Available options:
none
, medium
, large
typebot.theme.customCss
string
typebot.selectedThemeTemplateId
string | null
requiredtypebot.settings
object
requiredtypebot.settings.general
object
typebot.settings.general.isBrandingEnabled
boolean
typebot.settings.general.isTypingEmulationEnabled
boolean
typebot.settings.general.isInputPrefillEnabled
boolean
typebot.settings.general.isHideQueryParamsEnabled
boolean
typebot.settings.general.isNewResultOnRefreshEnabled
boolean
typebot.settings.general.rememberUser
object
typebot.settings.general.rememberUser.isEnabled
boolean
typebot.settings.general.rememberUser.storage
enum<string>
Available options:
session
, local
typebot.settings.typingEmulation
object
typebot.settings.typingEmulation.enabled
boolean
typebot.settings.typingEmulation.speed
number
typebot.settings.typingEmulation.maxDelay
number
typebot.settings.typingEmulation.delayBetweenBubbles
number
typebot.settings.typingEmulation.isDisabledOnFirstMessage
boolean
typebot.settings.metadata
object
typebot.settings.metadata.title
string
typebot.settings.metadata.description
string
typebot.settings.metadata.imageUrl
string
typebot.settings.metadata.favIconUrl
string
typebot.settings.metadata.customHeadCode
string
typebot.settings.metadata.googleTagManagerId
string
typebot.settings.whatsApp
object
typebot.settings.whatsApp.isEnabled
boolean
typebot.settings.whatsApp.startCondition
object
typebot.settings.whatsApp.startCondition.logicalOperator
enum<string>
requiredAvailable options:
OR
, AND
typebot.settings.whatsApp.startCondition.comparisons
object[]
requiredtypebot.settings.whatsApp.startCondition.comparisons.id
string
requiredtypebot.settings.whatsApp.startCondition.comparisons.comparisonOperator
enum<string>
Available options:
Equal to
, Not equal
, Contains
, Does not contain
, Greater than
, Less than
, Is set
, Is empty
, Starts with
, Ends with
, Matches regex
, Does not match regex
typebot.settings.whatsApp.startCondition.comparisons.value
string
typebot.settings.whatsApp.sessionExpiryTimeout
number
Expiration delay in hours after latest interaction
typebot.settings.publicShare
object
typebot.settings.publicShare.isEnabled
boolean
typebot.settings.security
object
typebot.settings.security.allowedOrigins
string[]
typebot.createdAt
string
requiredtypebot.updatedAt
string
requiredtypebot.icon
string | null
requiredtypebot.folderId
string | null
requiredtypebot.publicId
string | null
requiredtypebot.customDomain
string | null
requiredtypebot.workspaceId
string
requiredtypebot.resultsTablePreferences
object | null
requiredtypebot.resultsTablePreferences.columnsOrder
string[]
requiredtypebot.resultsTablePreferences.columnsVisibility
object
requiredtypebot.resultsTablePreferences.columnsWidth
object
requiredtypebot.isArchived
boolean
requiredtypebot.isClosed
boolean
requiredtypebot.whatsAppCredentialsId
string | null
requiredtypebot.riskLevel
number | null
requiredcurrentUserMode
enum<string>
requiredAvailable options:
guest
, read
, write
curl --request GET \
--url https://app.typebot.io/api/v1/typebots/{typebotId} \
--header 'Authorization: Bearer <token>'
{
"typebot": {
"version": "6",
"id": "<string>",
"name": "<string>",
"events": [
{
"id": "<string>",
"outgoingEdgeId": "<string>",
"graphCoordinates": {
"x": 123,
"y": 123
},
"type": "start"
}
],
"groups": [
{
"id": "<string>",
"title": "<string>",
"graphCoordinates": {
"x": 123,
"y": 123
},
"blocks": [
{
"id": "<string>",
"outgoingEdgeId": "<string>",
"type": "text",
"content": {
"html": "<string>",
"richText": [
"<any>"
],
"plainText": "<string>"
}
}
]
}
],
"edges": [
{
"id": "<string>",
"from": {
"blockId": "<string>",
"itemId": "<string>"
},
"to": {
"groupId": "<string>",
"blockId": "<string>"
}
}
],
"variables": [
{
"id": "<string>",
"name": "<string>",
"isSessionVariable": true,
"value": "<string>"
}
],
"theme": {
"general": {
"font": "<string>",
"background": {
"type": "Color",
"content": "<string>"
},
"progressBar": {
"isEnabled": true,
"color": "<string>",
"backgroundColor": "<string>",
"placement": "Top",
"thickness": 123,
"position": "fixed"
}
},
"chat": {
"container": {
"maxWidth": "<string>",
"maxHeight": "<string>",
"backgroundColor": "<string>",
"color": "<string>",
"blur": 123,
"opacity": 0.5,
"shadow": "none",
"border": {
"thickness": 123,
"color": "<string>",
"roundeness": "none",
"customRoundeness": 123,
"opacity": 0.5
}
},
"hostAvatar": {
"isEnabled": true,
"url": "<string>"
},
"guestAvatar": {
"isEnabled": true,
"url": "<string>"
},
"hostBubbles": {
"backgroundColor": "<string>",
"color": "<string>",
"blur": 123,
"opacity": 0.5,
"shadow": "none",
"border": {
"thickness": 123,
"color": "<string>",
"roundeness": "none",
"customRoundeness": 123,
"opacity": 0.5
}
},
"guestBubbles": {
"backgroundColor": "<string>",
"color": "<string>",
"blur": 123,
"opacity": 0.5,
"shadow": "none",
"border": {
"thickness": 123,
"color": "<string>",
"roundeness": "none",
"customRoundeness": 123,
"opacity": 0.5
}
},
"buttons": {
"backgroundColor": "<string>",
"color": "<string>",
"blur": 123,
"opacity": 0.5,
"shadow": "none",
"border": {
"thickness": 123,
"color": "<string>",
"roundeness": "none",
"customRoundeness": 123,
"opacity": 0.5
}
},
"inputs": {
"backgroundColor": "<string>",
"color": "<string>",
"blur": 123,
"opacity": 0.5,
"shadow": "none",
"border": {
"thickness": 123,
"color": "<string>",
"roundeness": "none",
"customRoundeness": 123,
"opacity": 0.5
},
"placeholderColor": "<string>"
},
"roundness": "none"
},
"customCss": "<string>"
},
"selectedThemeTemplateId": "<string>",
"settings": {
"general": {
"isBrandingEnabled": true,
"isTypingEmulationEnabled": true,
"isInputPrefillEnabled": true,
"isHideQueryParamsEnabled": true,
"isNewResultOnRefreshEnabled": true,
"rememberUser": {
"isEnabled": true,
"storage": "session"
}
},
"typingEmulation": {
"enabled": true,
"speed": 123,
"maxDelay": 123,
"delayBetweenBubbles": 2.5,
"isDisabledOnFirstMessage": true
},
"metadata": {
"title": "<string>",
"description": "<string>",
"imageUrl": "<string>",
"favIconUrl": "<string>",
"customHeadCode": "<string>",
"googleTagManagerId": "<string>"
},
"whatsApp": {
"isEnabled": true,
"startCondition": {
"logicalOperator": "OR",
"comparisons": [
{
"id": "<string>",
"comparisonOperator": "Equal to",
"value": "<string>"
}
]
},
"sessionExpiryTimeout": 24.005
},
"publicShare": {
"isEnabled": true
},
"security": {
"allowedOrigins": [
"<string>"
]
}
},
"createdAt": "<string>",
"updatedAt": "<string>",
"icon": "<string>",
"folderId": "<string>",
"publicId": "<string>",
"customDomain": "<string>",
"workspaceId": "<string>",
"resultsTablePreferences": {
"columnsOrder": [
"<string>"
],
"columnsVisibility": {},
"columnsWidth": {}
},
"isArchived": true,
"isClosed": true,
"whatsAppCredentialsId": "<string>",
"riskLevel": 123
},
"currentUserMode": "guest"
}