Get a typebot

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

typebotId

string

required

Where to find my bot's ID?

Query Parameters

migrateToLatestVersion

boolean

default: false

If enabled, the typebot will be converted to the latest schema version

Response

200 - application/json

typebot

object

required

• Typebot V6
• Typebot V5

Show child attributes

typebot.version

enum<string>

required

Available options:

6

typebot.id

string

required

typebot.name

string

required

typebot.events

object[]

required

Show child attributes

typebot.events.id

string

required

typebot.events.outgoingEdgeId

string

typebot.events.graphCoordinates

object

required

Show child attributes

typebot.events.graphCoordinates.x

number

required

typebot.events.graphCoordinates.y

number

required

typebot.events.type

enum<string>

required

Available options:

start

typebot.groups

object[]

required

Show child attributes

typebot.groups.id

string

required

typebot.groups.title

string

required

typebot.groups.graphCoordinates

object

required

Show child attributes

typebot.groups.graphCoordinates.x

number

required

typebot.groups.graphCoordinates.y

number

required

typebot.groups.blocks

object[]

required

• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block
• Block

Show child attributes

typebot.groups.blocks.id

string

required

typebot.groups.blocks.outgoingEdgeId

string

typebot.groups.blocks.type

enum<string>

required

Available options:

text

typebot.groups.blocks.content

object

Show child attributes

typebot.groups.blocks.content.html

string

typebot.groups.blocks.content.richText

any[]

typebot.groups.blocks.content.plainText

string

typebot.edges

object[]

required

Show child attributes

typebot.edges.id

string

required

typebot.edges.from

object

required

• Option 1
• Option 2

Show child attributes

typebot.edges.from.blockId

string

required

typebot.edges.from.itemId

string

typebot.edges.to

object

required

Show child attributes

typebot.edges.to.groupId

string

required

typebot.edges.to.blockId

string

typebot.variables

object[]

required

Show child attributes

typebot.variables.id

string

required

typebot.variables.name

string

required

typebot.variables.value

typebot.theme

object

required

Show child attributes

typebot.theme.general

object

Show child attributes

typebot.theme.general.font

typebot.theme.general.background

object

Show child attributes

typebot.theme.general.background.type

enum<string>

Available options:

Color,

Image,

None

typebot.theme.general.background.content

string

typebot.theme.general.progressBar

object

Show child attributes

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

Show child attributes

typebot.theme.chat.hostAvatar

object

Show child attributes

typebot.theme.chat.hostAvatar.isEnabled

boolean

typebot.theme.chat.hostAvatar.url

string

typebot.theme.chat.guestAvatar

object

Show child attributes

typebot.theme.chat.guestAvatar.isEnabled

boolean

typebot.theme.chat.guestAvatar.url

string

typebot.theme.chat.hostBubbles

object

Show child attributes

typebot.theme.chat.hostBubbles.backgroundColor

string

typebot.theme.chat.hostBubbles.color

string

typebot.theme.chat.guestBubbles

object

Show child attributes

typebot.theme.chat.guestBubbles.backgroundColor

string

typebot.theme.chat.guestBubbles.color

string

typebot.theme.chat.buttons

object

Show child attributes

typebot.theme.chat.buttons.backgroundColor

string

typebot.theme.chat.buttons.color

string

typebot.theme.chat.inputs

object

Show child attributes

typebot.theme.chat.inputs.backgroundColor

string

typebot.theme.chat.inputs.color

string

typebot.theme.chat.inputs.placeholderColor

string

typebot.theme.chat.roundness

enum<string>

Available options:

none,

medium,

large

typebot.theme.customCss

string

typebot.selectedThemeTemplateId

string | null

required

typebot.settings

object

required

Show child attributes

typebot.settings.general

object

Show child attributes

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

Show child attributes

typebot.settings.general.rememberUser.isEnabled

boolean

typebot.settings.general.rememberUser.storage

enum<string>

Available options:

session,

local

typebot.settings.typingEmulation

object

Show child attributes

typebot.settings.typingEmulation.enabled

boolean

typebot.settings.typingEmulation.speed

number

typebot.settings.typingEmulation.maxDelay

number

typebot.settings.typingEmulation.delayBetweenBubbles

number

Required range: 0 < x < 5

typebot.settings.typingEmulation.isDisabledOnFirstMessage

boolean

typebot.settings.metadata

object

Show child attributes

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

Show child attributes

typebot.settings.whatsApp.isEnabled

boolean

typebot.settings.whatsApp.startCondition

object

Show child attributes

typebot.settings.whatsApp.startCondition.logicalOperator

enum<string>

required

Available options:

OR,

AND

typebot.settings.whatsApp.startCondition.comparisons

object[]

required

Show child attributes

typebot.settings.whatsApp.sessionExpiryTimeout

number

Expiration delay in hours after latest interaction

Required range: 0.01 < x < 48

typebot.settings.publicShare

object

Show child attributes

typebot.settings.publicShare.isEnabled

boolean

typebot.settings.security

object

Show child attributes

typebot.settings.security.allowedOrigins

string[]

typebot.createdAt

string

required

typebot.updatedAt

string

required

typebot.icon

string | null

required

typebot.folderId

string | null

required

typebot.publicId

string | null

required

typebot.customDomain

string | null

required

typebot.workspaceId

string

required

typebot.resultsTablePreferences

object | null

required

Show child attributes

typebot.resultsTablePreferences.columnsOrder

string[]

required

typebot.resultsTablePreferences.columnsVisibility

object

required

Show child attributes

typebot.resultsTablePreferences.columnsVisibility.{key}

boolean

typebot.resultsTablePreferences.columnsWidth

object

required

Show child attributes

typebot.resultsTablePreferences.columnsWidth.{key}

number

typebot.isArchived

boolean

required

typebot.isClosed

boolean

required

typebot.whatsAppCredentialsId

string | null

required

typebot.riskLevel

number | null

required

currentUserMode

enum<string>

required

Available options:

guest,

read,

write