Skip to main content

API Reference

Complete reference documentation for all Gravity Rail API endpoints.

Base URL: https://api.gravityrail.com/api/v2

Every endpoint requires authentication with an API key or OAuth token unless marked otherwise — see the Authentication guide. For a curl-first tour of the most common calls, start with the Quick Reference. TypeScript users can call the same API through the SDK.

Pages are grouped by scope: Global APIs act on your account and organizations; Workspace APIs act inside a single workspace and are prefixed with /api/v2/w/{workspace_uuid}.

API Modules​

The API is organized into the following categories:

Global​

  • AI Models · 7 endpoints — Available AI models and capabilities
  • Account · 3 endpoints — User account management
  • Features · 3 endpoints — Available platform features and capabilities
  • Organizations · 3 endpoints — Organization public configuration
  • Resources · 2 endpoints — Resource metadata and definitions

Workspace​

  • Abilities · 6 endpoints — Workflow ability configuration and management
  • Assignments · 10 endpoints — Task and workflow assignments
  • Calendar Event Types · 5 endpoints — Calendar event type definitions
  • Calendar Events · 8 endpoints — Calendar event management
  • Calendars · 9 endpoints — Calendar and scheduling management
  • Calls · 1 endpoint — Voice call history and management
  • Chat Labels · 5 endpoints — Chat conversation tagging and categorization
  • Chats · 19 endpoints — Conversation threads between Members, Agents, and staff across web, SMS, email, and voice
  • Custom Toolkits · 7 endpoints — Custom AI toolkit creation and management
  • Data Records · 4 endpoints — Structured data record CRUD within a data type
  • Data Types · 7 endpoints — Custom data type management
  • Event Rules · 11 endpoints — Event-driven automation rules
  • Files · 8 endpoints — File upload and management
  • Folders · 11 endpoints — File and document folder management
  • Inboxes · 5 endpoints — Email inbox and message thread management
  • Journey Notes · 4 endpoints — Notes and annotations on member journeys
  • Journeys · 6 endpoints — Member journey tracking and progression
  • Journeys Enrollment · 6 endpoints — Enroll, unenroll, and re-enroll members in journeys
  • MCP Servers · 14 endpoints — Model Context Protocol server management
  • Member Labels · 5 endpoints — Member tagging and categorization
  • Member Roles · 5 endpoints — Member role and permission management
  • Members · 24 endpoints — The people in a workspace — roster, profiles, custom fields, and bulk import/export
  • Menu · 6 endpoints — Workspace menu customization and navigation
  • Notification Rules · 4 endpoints — Notification delivery rules and triggers
  • Notifications · 6 endpoints — Notification management
  • Phone Numbers · 8 endpoints — Phone number and SMS management
  • Push Subscriptions · 3 endpoints — Web push notification subscription management
  • Recordings · 2 endpoints — Voice call recordings
  • Routines · 10 endpoints — Routines — the unified automation primitive (schedule, webhook, and system-event triggers)
  • Settings · 5 endpoints — Workspace configuration and settings management
  • Sharing · 4 endpoints — Resource sharing and share-link management
  • Sites · 6 endpoints — Website and content management
  • Snippets · 5 endpoints — Reusable content snippets and macros
  • Tasks · 8 endpoints — Task execution and monitoring
  • Toolkits · 2 endpoints — Available AI toolkits and capabilities
  • Webhook Logs · 1 endpoint — Webhook request history and debugging
  • Workflows · 32 endpoints — Create and run Workflows — multi-step processes with Tasks, permissions, and escalation rules