Quick Start

Follow these steps to create your first Bridge and start using the API.

Step 1: Prepare Your Spreadsheet

Ensure your Google Spreadsheet has column names in the first row. See the Spreadsheet Guide for detailed formatting requirements.

Step 2: Create a Bridge

Log in to SheetBridge with your Google account. After authentication, you'll be automatically redirected to the Bridges page.

On the Bridges page, enter your Google Spreadsheet URL or ID in the form field:

  • You can use the full URL: https://docs.google.com/spreadsheets/d/1ABC.../edit
  • Or just the ID: 1ABC...

Click "Create Bridge" to proceed.

SheetBridge will validate access to your spreadsheet and create the Bridge. A Bearer token is automatically generated for API authentication.

Dashboard showing your bridges

Step 3: Get Your API Endpoints

After creating the Bridge, you'll be redirected to the Bridge details page where you can see:

  • All sheets in your spreadsheet
  • API endpoint URLs for each sheet
  • Available operations (GET, POST, PUT, DELETE) for each endpoint

Each endpoint follows this format:

/api/v1/bridge/{bridgeId}/{sheetId}

Copy the endpoint URL you want to use from the Bridge details page.

Step 4: Make Your First Request

Use the endpoint URL to make API requests. For example, to list all rows:

curl "https://your-domain.com/api/v1/bridge/{bridgeId}/{sheetId}"

If your Bridge has authentication enabled (default), include the Bearer token:

curl "https://your-domain.com/api/v1/bridge/{bridgeId}/{sheetId}" \
  -H "Authorization: Bearer YOUR_TOKEN"

See the API Reference for complete endpoint documentation.


Powered by Converge