GET
/
v1
/
typebots
/
{typebotId}
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>",
        "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": {
        "hostAvatar": {
          "isEnabled": true,
          "url": "<string>"
        },
        "guestAvatar": {
          "isEnabled": true,
          "url": "<string>"
        },
        "hostBubbles": {
          "backgroundColor": "<string>",
          "color": "<string>"
        },
        "guestBubbles": {
          "backgroundColor": "<string>",
          "color": "<string>"
        },
        "buttons": {
          "backgroundColor": "<string>",
          "color": "<string>"
        },
        "inputs": {
          "backgroundColor": "<string>",
          "color": "<string>",
          "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
header
required

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
Successful response
​
typebot
object
required
​
currentUserMode
enum<string>
required
Available options:
guest,
read,
write
Suggest edits