API Reference

Authentication

Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Keep your API key secret. Do not expose it in client-side code or public repositories.

Base URL

https://orbitforms.ai/api/v1

Endpoints

Forms

List all forms

curl -X GET "https://orbitforms.ai/api/v1/forms" \
  -H "Authorization: Bearer YOUR_API_KEY"

Get form submissions

curl -X GET "https://orbitforms.ai/api/v1/forms/:formId/submissions" \
  -H "Authorization: Bearer YOUR_API_KEY"

Create form (title is required)

curl -X POST "https://orbitforms.ai/api/v1/forms" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title": "My Form", "fields": [...]}'

Contacts

List contacts (with optional filters: page, per_page, status, search, tag)

curl -X GET "https://orbitforms.ai/api/v1/contacts?status=active&per_page=50" \
  -H "Authorization: Bearer YOUR_API_KEY"

Get contact

curl -X GET "https://orbitforms.ai/api/v1/contacts/:contactId" \
  -H "Authorization: Bearer YOUR_API_KEY"

Update contact

curl -X PATCH "https://orbitforms.ai/api/v1/contacts/:contactId" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"custom_fields": {"company": "Acme Inc"}}'

Add tag to contact

curl -X POST "https://orbitforms.ai/api/v1/contacts/:contactId/tags" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tag_id": "tag_xyz"}'

Remove tag from contact

curl -X DELETE "https://orbitforms.ai/api/v1/contacts/:contactId/tags?tag_id=tag_xyz" \
  -H "Authorization: Bearer YOUR_API_KEY"

Contact Tags

List contact tags

curl -X GET "https://orbitforms.ai/api/v1/contact-tags" \
  -H "Authorization: Bearer YOUR_API_KEY"

Create contact tag

curl -X POST "https://orbitforms.ai/api/v1/contact-tags" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "High Intent"}'

Delete contact tag

curl -X DELETE "https://orbitforms.ai/api/v1/contact-tags/:tagId" \
  -H "Authorization: Bearer YOUR_API_KEY"

Scheduling Pages

List scheduling pages

curl -X GET "https://orbitforms.ai/api/v1/scheduling-pages" \
  -H "Authorization: Bearer YOUR_API_KEY"

Get scheduling page

curl -X GET "https://orbitforms.ai/api/v1/scheduling-pages/:id" \
  -H "Authorization: Bearer YOUR_API_KEY"

Create scheduling page (title is required)

curl -X POST "https://orbitforms.ai/api/v1/scheduling-pages" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title": "30-min Call", "page_type": "one_on_one"}'

Delete scheduling page

curl -X DELETE "https://orbitforms.ai/api/v1/scheduling-pages/:id" \
  -H "Authorization: Bearer YOUR_API_KEY"

Meetings

List meetings (optional filters: status, since, until, scheduling_page_id, page, per_page)

curl -X GET "https://orbitforms.ai/api/v1/meetings?status=completed&per_page=20" \
  -H "Authorization: Bearer YOUR_API_KEY"

Get meeting

curl -X GET "https://orbitforms.ai/api/v1/meetings/:id" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example response:

{
  "data": {
    "id": "meeting_abc123",
    "status": "completed",
    "attendee_name": "Jane Doe",
    "attendee_email": "[email protected]",
    "start_time": "2026-03-07T14:00:00Z",
    "end_time": "2026-03-07T14:30:00Z",
    "timezone": "America/New_York",
    "meeting_link": "https://...",
    "notes": "Discussed pricing and implementation timeline",
    "scheduling_page_id": "page_xyz",
    "created_at": "2026-03-01T09:00:00Z"
  }
}

Update meeting (allowed fields: status, notes, cancellation_reason)

curl -X PATCH "https://orbitforms.ai/api/v1/meetings/:id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status": "cancelled", "cancellation_reason": "Requested by attendee"}'

Delete meeting

curl -X DELETE "https://orbitforms.ai/api/v1/meetings/:id" \
  -H "Authorization: Bearer YOUR_API_KEY"

Availability Schedules

List availability schedules

curl -X GET "https://orbitforms.ai/api/v1/availability-schedules" \
  -H "Authorization: Bearer YOUR_API_KEY"

Get availability schedule

curl -X GET "https://orbitforms.ai/api/v1/availability-schedules/:id" \
  -H "Authorization: Bearer YOUR_API_KEY"

Sequences

Sequences have a separate API reference. See Sequences API for full documentation.

Rate Limits

API requests are rate limited per API key. Read endpoints allow 1,000 requests per minute; creation endpoints have their own hourly caps (for example, 100 form creations per hour). OAuth apps receive tiered limits based on their verification status. Exceeding a limit returns 429 Too Many Requests with a Retry-After header telling you when to try again.

Iframe Tracking Integration

Send tracking parameters from your page into OrbitForms forms for attribution and analytics.

How It Works

Pass tracking fields to the form — Add comet_token as a query param on the form’s URL, or send any of the supported fields from your page into the embedded form via postMessage
Orbit captures them — When a user submits, these values are stored with the submission
Use in workflows — Reference them in workflows, webhooks, or exports for attribution reporting

Arbitrary URL parameters can also be captured with Hidden fields — set a hidden field’s value source to “URL parameter” and it will store that query param with every submission.

Supported Tracking Fields

Field	Description
`comet_token`	Cometly attribution token
`attribution_id`	Generic attribution ID
`tracking_id`	Campaign or source tracking
`visitor_id`	Visitor identifier
`session_id`	Session identifier

Example (JavaScript, parent page of an iframe embed):

// Send tracking fields into the embedded form
const iframe = document.querySelector('iframe');
iframe.contentWindow.postMessage({
  comet_token: 'abc123',
  attribution_id: 'campaign_xyz',
  visitor_id: getVisitorId()
}, 'https://orbitforms.ai');

When embedding via iframe, the parent page can also pass these fields to the form with postMessage — see the Cometly iframe-tracking pattern linked in the Embed Script documentation. If you’re an analytics or attribution provider and want to integrate with OrbitForms, contact support for partnership options.

Building Forms

Building Scheduling

Sharing & Embedding

Workflows

AI Nodes

Sequences

Data & Analytics

Security

Team & Settings

Resources

Authentication

Base URL

Endpoints

Forms

Contacts

Contact Tags

Scheduling Pages

Meetings

Availability Schedules

Sequences

Rate Limits

Iframe Tracking Integration

How It Works

Supported Tracking Fields

Next Steps

Webhooks

Integrations

​Authentication

​Base URL

​Endpoints

​Forms

​Contacts

​Contact Tags

​Scheduling Pages

​Meetings

​Availability Schedules

​Sequences

​Rate Limits

​Iframe Tracking Integration

​How It Works

​Supported Tracking Fields

​Next Steps

Webhooks

Integrations

Authentication

Base URL

Endpoints

Forms

Contacts

Contact Tags

Scheduling Pages

Meetings

Availability Schedules

Sequences

Rate Limits

Iframe Tracking Integration

How It Works

Supported Tracking Fields

Next Steps