> ## Documentation Index
> Fetch the complete documentation index at: https://docs.toolzz.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a Toolzz Bot

> Endpoint to get a Toolzz Bot

### Parameters

<ParamField path="typebotId" type="string">
  botId: The bot ID to get.
</ParamField>

## Response Description

Below you will see the description of the function get a toolzz bot.

<ResponseField name="typebot" type="object[]" required>
  Toolzz Bots information.

  <Expandable title="messages properties">
    <ResponseField name="version" type="string" required>
      The current version of the platform.
    </ResponseField>

    <ResponseField name="id" type="string" required>
      Unique identifier for a bot.
    </ResponseField>

    <ResponseField name="name" type="string" required>
      The Toolzz bot name.
    </ResponseField>

    <ResponseField name="events" type="object[]" required>
      The events occurred on bot flow.

      <Expandable title="events properties">
        <ResponseField name="id" type="string">
          Unique identifier for a flow event.
        </ResponseField>

        <ResponseField name="outgoingEdgeId" type="string" required>
          Unique identifier for a specific block in a flow.
        </ResponseField>

        <ResponseField name="graphCoordinates" type="object" required>
          The positioning of a block.

          <Expandable title="graphCoordinates properties">
            <ResponseField name="x" type="number" required>
              The coordinate for positioning.
            </ResponseField>

            <ResponseField name="y" type="number" required>
              The coordinate for positioning.
            </ResponseField>
          </Expandable>
        </ResponseField>
      </Expandable>

      <ResponseField name="type" type="string">
        The type of the block.
      </ResponseField>

      <ResponseField name="groups" type="object[]">
        The bot group information.

        <Expandable title="groups properties">
          <ResponseField name="id" type="string" required>
            Unique identifier for a group.
          </ResponseField>

          <ResponseField name="title" type="string" required>
            The title of the group.
          </ResponseField>

          <ResponseField name="graphCoordinates" type="object" required>
            The positioning of a block.

            <Expandable title="graphCoordinates properties">
              <ResponseField name="x" type="number" required>
                The coordinate for positioning.
              </ResponseField>

              <ResponseField name="y" type="number" required>
                The coordinate for positioning.
              </ResponseField>

              <ResponseField name="Blocks" type="object[]" required>
                The coordinate for positioning.

                <Expandable title="Blocks properties">
                  <ResponseField name="id" type="string" required>
                    The unique identifier of the block.
                  </ResponseField>

                  <ResponseField name="type" type="string" required>
                    The type of the block.
                  </ResponseField>

                  <ResponseField name="content" type="string" required>
                    The content of the of the block.
                  </ResponseField>
                </Expandable>

                <ResponseField name="Edge" type="object[]" required>
                  The positioning of the block.
                </ResponseField>
              </ResponseField>

              <ResponseField name="variables" type="object[]" required>
                The variables related to the bot.
              </ResponseField>
            </Expandable>
          </ResponseField>

          <ResponseField name="theme" type="object[]" required>
            The pre setted theme of the bot.
          </ResponseField>

          <ResponseField name="settings" type="object[]" required>
            The settings related to the bot.
          </ResponseField>

          <ResponseField name="createdAt" type="string" required>
            The bot creation data.
          </ResponseField>

          <ResponseField name="updatedAt" type="string" required>
            The bot update data.
          </ResponseField>

          <ResponseField name="icon" type="string" required>
            The visual appereance of the bot.
          </ResponseField>

          <ResponseField name="folderId" type="string" required>
            The unique identifier for the bot folder.
          </ResponseField>

          <ResponseField name="workspaceId" type="string" required>
            The unique identifier for the bot workspace.
          </ResponseField>

          <ResponseField name="resultsTablePreferences" type="string" required>
            The preferences for the results table of the bot.
          </ResponseField>

          <ResponseField name="isArchived" type="boolean" required>
            The verifier to archived bots.
          </ResponseField>

          <ResponseField name="isClosed" type="boolean" required>
            The verifier to closed bots.
          </ResponseField>
        </Expandable>
      </ResponseField>

      <ResponseField name="currentUserMode" type="string" required>
        The type of user mode.
      </ResponseField>
    </ResponseField>
  </Expandable>
</ResponseField>