---
title: "Bubble"
description: "Read explicitly selected fields from enabled Bubble Data API records with a customer administrator token. Correct live/branch API root and explicit cursor paging; the token bypasses Bubble privacy rules. No writes, workf"
---

> Documentation Index
> Fetch the complete documentation index at: https://help.tooluse.net/llms.txt
> Use this file to discover all available pages before exploring further.

# Bubble

<p>Read explicitly selected fields from enabled Bubble Data API records with a customer administrator token. Correct live/branch API root and explicit cursor paging; the token bypasses Bubble privacy rules. No writes, workflows, arbitrary API routes or managed user login.</p>

<details data-command-index><summary>What you can do (2)</summary>
<h2>What you can do</h2>
<p>Available commands: 2 (2 read, 0 write). Enable only the commands your application needs.</p>
<div class="nb-table-scroll"><table>
<thead>
<tr>
<th>Command</th>
<th>Effect</th>
</tr>
</thead>
<tbody><tr>
<td><a href="https://help.tooluse.net/integrations/bubble#command-bubble-records-list">List selected record fields</a> — <code>bubble.records.list</code></td>
<td>Read</td>
</tr>
<tr>
<td><a href="https://help.tooluse.net/integrations/bubble#command-bubble-records-get">Get selected record fields</a> — <code>bubble.records.get</code></td>
<td>Read</td>
</tr>
</tbody></table>
</div>
</details>
<h2>Connect and use</h2>

<p><a href="https://www.tooluse.net/tools/integrations/bubble">Connect and use</a></p>
<p>Open the integration&#39;s connection form to check the available credential source. The source has not been resolved for this documentation export. The instructions below apply when using your own provider account.</p>
<h2>Get your provider credentials</h2>
<p>Follow these steps for Bubble, then enter the issued values in the connection form below.</p>
<ol>
<li>In your Bubble editor, open Settings → API, enable the Data API and expose the required data types. Generate a named API token and copy it into API token in this connection form. Enter the exact HTTPS Data API root from the editor (ending /api/1.1, with the correct live or branch prefix); do not include /obj. Deploy settings before using live data. Select reads and save. This administrator token bypasses Bubble privacy rules. In each example, replace type/id and explicitly choose the output fields; _id is always included. Only those fields are returned to the caller, but Bubble still sends the accessible record to Tooluse.net. Cursor plus count selects another page. No workflow API, writes, token login or automatic paging.</li>
</ol>
<p><a href="https://manual.bubble.io/core-resources/api/the-bubble-api/the-data-api/authentication">Official credential setup</a></p>
<h2>Where to enter credentials</h2>
<p>In the integration page, sign in, choose your workspace and open Connect. If a <strong>Credentials</strong> choice is shown, select <strong>Use my credentials</strong>. Fill the following connection fields and save. Provider credentials belong in this form, never in an MCP configuration or tool input.</p>
<div class="nb-table-scroll"><table>
<thead>
<tr>
<th>Connection field</th>
<th>Requirement</th>
</tr>
</thead>
<tbody><tr>
<td>Bubble Data API root URL</td>
<td>Required</td>
</tr>
<tr>
<td>API token</td>
<td>Required</td>
</tr>
</tbody></table>
</div><p>Open API keys and create a Tooluse.net key for the enabled commands.</p>
<p>Set TOOLUSE_API_KEY in your client and use the shared MCP configuration.</p>
<p><a href="https://help.tooluse.net/clients">Configure Claude Code, Codex or Cursor once</a></p>

<h2>Permissions and results</h2>

<p>If you have more than one workspace, check the selected workspace in the connection or API-key dialog before saving. Roles, enabled commands, expiry and revocation use Tooluse.net&#39;s existing permissions. Disabling a connection or revoking a key immediately prevents new calls.</p>

<p>Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.</p>

<p>Your connection&#39;s daily allowance and key permissions also apply. Adding a connection does not make a provider request.</p>

<p>Calls return the shared execution receipt and a Claude tool_result. Provider output varies by operation; consult the provider documentation for its response fields. Unconfirmed calls should be checked before retrying.</p>

<h2>Call from your client</h2>

<p>Use the shared MCP configuration. Refresh your client&#39;s tool list after saving the connection or changing key permissions, then call the returned tool name with the example input below.</p>

<p><a href="https://help.tooluse.net/clients">Configure Claude Code, Codex or Cursor once</a></p>

<h2>Discover your enabled tools</h2>

<p>List permitted tools in Claude format. Read every page using page and size (maximum 100) until all results have been received. Use the returned name, not a catalog capability identifier, in the tool_use block.</p>

<pre><code class="language-bash">curl 'https://api.tooluse.net/v1/tools' \
  -H "Authorization: Bearer $TOOLUSE_API_KEY"
</code></pre>

<p>Find this command in the tool list permitted by your key. Replace svc_FROM_YOUR_TOOL_LIST with its returned name. Use a new Idempotency-Key for each new call and retain it when retrying that same call.</p>

<h2>HTTP call</h2>

<pre><code class="language-bash">curl 'https://api.tooluse.net/v1/tool-calls' \
  -H "Authorization: Bearer $TOOLUSE_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: replace-with-a-new-call-id' \
  --data '{
  "type": "tool_use",
  "id": "toolu_example",
  "name": "svc_FROM_YOUR_TOOL_LIST",
  "input": {
    "path": {
      "type": "rentalunit"
    },
    "query": {
      "cursor": 0,
      "limit": 20
    },
    "fields": [
      "Unit name"
    ]
  }
}'
</code></pre>

<p>Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.</p>

<h2>Commands</h2>

<details id="command-bubble-records-list">
<summary><span>List selected record fields — <code>bubble.<wbr>records.<wbr>list</code></span></summary>
<p>Read one explicit cursor/limit page from an enabled Bubble data type and return only _id plus the output fields you select. The administrator token bypasses Bubble privacy rules; select only data intended for this client. No workflow calls, writes or automatic paging.</p>

<p>This is a read operation. Provider rate limits and data access rules still apply.</p>

<p><a href="https://www.tooluse.net/tools/integrations/bubble?command=bubble.records.list">Connect and use</a></p>

<p><strong>Parameters</strong></p>

<p>Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.</p>

<div class="nb-table-scroll"><table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Required in parent</th>
<th>Description</th>
<th>Constraints</th>
</tr>
</thead>
<tbody><tr>
<td><code>path</code></td>
<td>object</td>
<td>Required</td>
<td></td>
<td><code>additionalProperties: false</code></td>
</tr>
<tr>
<td><code>path.type</code></td>
<td>string</td>
<td>Required</td>
<td>Exact exposed Bubble data type API name.</td>
<td><code>pattern: &quot;^[a-z][a-z0-9_-]{0,99}$&quot;</code></td>
</tr>
<tr>
<td><code>query</code></td>
<td>object</td>
<td>Required</td>
<td></td>
<td><code>additionalProperties: false</code></td>
</tr>
<tr>
<td><code>query.cursor</code></td>
<td>integer</td>
<td>Required</td>
<td>Zero-based record offset; next page is returned cursor plus count.</td>
<td><code>minimum: 0; maximum: 9007199254740991</code></td>
</tr>
<tr>
<td><code>query.limit</code></td>
<td>integer</td>
<td>Required</td>
<td>Maximum records for this explicit page.</td>
<td><code>minimum: 1; maximum: 100</code></td>
</tr>
<tr>
<td><code>fields</code></td>
<td>array</td>
<td>Required</td>
<td>Local response projection, not a provider query or a privacy boundary. _id is always included. Use field names returned by your Bubble API.</td>
<td><code>minItems: 1; maxItems: 20; uniqueItems: true</code></td>
</tr>
<tr>
<td><code>fields[]</code></td>
<td>string</td>
<td>Optional</td>
<td>Exact field name to include in output, e.g. Unit name.</td>
<td><code>minLength: 1; maxLength: 100</code></td>
</tr>
</tbody></table>
</div>
<p><strong>Full JSON Schema</strong></p>

<p><a href="https://api.tooluse.net/v1/integrations/bubble/commands/bubble.records.list">Full JSON Schema</a></p>

<p><strong>Example input</strong></p>

<pre><code class="language-json">{
  "path": {
    "type": "rentalunit"
  },
  "query": {
    "cursor": 0,
    "limit": 20
  },
  "fields": [
    "Unit name"
  ]
}
</code></pre>

<p>At most 1 provider requests per invocation; timeout: 30 seconds.</p>

</details>
<details id="command-bubble-records-get">
<summary><span>Get selected record fields — <code>bubble.<wbr>records.<wbr>get</code></span></summary>
<p>Read one known record, returning _id and only explicitly selected output fields. Uses a customer administrator API token, with no privacy-rule enforcement by Bubble. Does not modify data or invoke workflows.</p>

<p>This is a read operation. Provider rate limits and data access rules still apply.</p>

<p><a href="https://www.tooluse.net/tools/integrations/bubble?command=bubble.records.get">Connect and use</a></p>

<p><strong>Parameters</strong></p>

<p>Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.</p>

<div class="nb-table-scroll"><table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Required in parent</th>
<th>Description</th>
<th>Constraints</th>
</tr>
</thead>
<tbody><tr>
<td><code>path</code></td>
<td>object</td>
<td>Required</td>
<td></td>
<td><code>additionalProperties: false</code></td>
</tr>
<tr>
<td><code>path.type</code></td>
<td>string</td>
<td>Required</td>
<td>Exact exposed Bubble data type API name.</td>
<td><code>pattern: &quot;^[a-z][a-z0-9_-]{0,99}$&quot;</code></td>
</tr>
<tr>
<td><code>path.id</code></td>
<td>string</td>
<td>Required</td>
<td>Full unique record ID copied from Bubble.</td>
<td><code>pattern: &quot;^[A-Za-z0-9_-]{1,200}$&quot;</code></td>
</tr>
<tr>
<td><code>fields</code></td>
<td>array</td>
<td>Required</td>
<td>Local response projection, not a provider query or a privacy boundary. _id is always included. Use field names returned by your Bubble API.</td>
<td><code>minItems: 1; maxItems: 20; uniqueItems: true</code></td>
</tr>
<tr>
<td><code>fields[]</code></td>
<td>string</td>
<td>Optional</td>
<td>Exact field name to include in output, e.g. Unit name.</td>
<td><code>minLength: 1; maxLength: 100</code></td>
</tr>
</tbody></table>
</div>
<p><strong>Full JSON Schema</strong></p>

<p><a href="https://api.tooluse.net/v1/integrations/bubble/commands/bubble.records.get">Full JSON Schema</a></p>

<p><strong>Example input</strong></p>

<pre><code class="language-json">{
  "path": {
    "type": "rentalunit",
    "id": "1671702337369x488321592367327900"
  },
  "fields": [
    "Unit name"
  ]
}
</code></pre>

<p>At most 1 provider requests per invocation; timeout: 30 seconds.</p>

</details>
<h2>Errors</h2>

<p>Check the key&#39;s expiry, revocation, workspace and allowed operations.</p>

<p>Reuse the same idempotency key only for the same request.</p>

<p>The connection or provider limit has been reached. Check the receipt before retrying.</p>

<h2>Test the connection</h2>

<p>Open the integration&#39;s commands below to inspect parameters and examples. Start with a read command for an account or resource you can access. Refresh your client&#39;s tool list, use the returned tool name, and check the execution result and usage. Provider charges and permissions still apply. Never test a write against production data without reviewing it.</p>

<p><a href="https://manual.bubble.io/core-resources/api/the-bubble-api/the-data-api/data-api-requests">Official provider documentation</a></p>

Source: https://help.tooluse.net/integrations/bubble/index.mdx