Bridge APIIntroduction

API introduction

The Bridge API base URL, how requests and responses are shaped, and every endpoint available in v1.

The Bridge API is a REST API that uses JSON for requests and responses. Every request is made over HTTPS and authenticated with an API key from your workspace.

Base URL

https://api.meetonbridge.com/v1

The v1 in the path is the API version. New fields can be added to v1 at any time, so ignore fields you don't recognise. A change that would break existing code gets a new version.

The Bridge API is available to workspaces on the Business and Enterprise plans. Workspace owners create API keys in Settings → API keys. See Authentication.

Requests

  • Send the key in the Authorization header: Authorization: Bearer bridge_live_...
  • Send request bodies as JSON with Content-Type: application/json.
  • Send dates and times as ISO 8601 with an offset, such as 2026-11-02T15:00:00Z.
  • Send time zones as IANA names, such as America/New_York.

Responses

A successful response has status: "success" and the result in data:

{
  "status": "success",
  "data": {
    "id": "6f1c2a3b-4d5e-4f60-8a7b-9c0d1e2f3a4b",
    "name": "Product demo"
  }
}

Lists that can be long also include pagination. See Rate limits and pagination.

An error has status: "error" and an error object with a code and a readable message:

{
  "status": "error",
  "error": {
    "code": "validation_error",
    "message": "take: Number must be less than or equal to 100"
  }
}

See Errors for every code.

Times in responses are always ISO 8601 in UTC.

Endpoints

MethodPathAccessWhat it does
GET/meReadThe API key, the person it acts as, and the workspace
GET/booking-pagesReadList booking pages
POST/booking-pagesWriteCreate a booking page
GET/booking-pages/{id}ReadGet a booking page, including its booking form questions
PATCH/booking-pages/{id}WriteUpdate a booking page
DELETE/booking-pages/{id}WriteDelete a booking page
GET/collectionsReadList collections
GET/slotsReadOpen start times on a booking page
GET/bookingsReadList bookings, with filters for syncing
POST/bookingsWriteBook a meeting
GET/bookings/{id}ReadGet a booking
POST/bookings/{id}/rescheduleWriteMove a booking to a new time
POST/bookings/{id}/cancelWriteCancel a booking

Read endpoints work with any key. Write endpoints need a key with read and write access.

The full reference, with every field and a "Try it" console, is in the API reference section of this tab.

OpenAPI specification

The API publishes an OpenAPI document you can load into tools like Postman or use to generate a client:

https://api.meetonbridge.com/v1/openapi.json

It doesn't need an API key.

Was this page helpful?