Skip to content
/
Overview
Last updated

Welcome to the Frontline Public API & Docs. Our API gives you programmatic access to your CRM, agents, flows, workflows, tables, analytics, billing and more.

This section covers the concepts and conventions of the API. For per-endpoint details see the API Reference.

What you can do

  • Manage your CRM — read and write Objects (People, Companies, Deals, and your own custom objects): record types, fields, rows, views, relations, notes, tasks, and files. This is the heart of Frontline, and everything else is built on top of it.
  • Manage agents — list, create, update, deploy, and inspect AI agents, including their channel settings, intents, and the tools and models they can use.
  • Run automation workflows — define triggers, build the graph, manage workflow variables, and pull run analytics to see what fired and when.
  • Work with tables — manage spreadsheet-style datasets when you need lightweight, structured data that doesn't warrant a full CRM object.
  • Track usage — inspect credits consumed, conversations by channel, and workflow analytics.
  • Billing — view your plan, remaining credits, and subscription renewal details.

Base URL

https://prod-api.getfrontline.ai

All Public API endpoints are prefixed with /public/v1.

Getting started

  • Getting started — your first authenticated request, step by step.
  • Authentication — USER vs GENERAL keys and which endpoints need which.
  • Rate limits — current quotas and how to handle 429 responses.
  • Errors — error envelope, status codes, and recommended client handling.

Core Concepts

  • Standard Objects — the built-in CRM objects: People, Companies, Deals, Tickets.
  • Objects — CRM entities with record types and relations.
  • Field Types — every field type, its metadata, defaults, and unique constraints.
  • Querying and Filtering — JSON Query DSL to filter, search, and sort CRM objects and custom tables.
  • Record Types — categories within an Object.
  • Tables — spreadsheet-style datasets.
  • Agents — the AI assistants you ship.
  • Flows — conversation graphs that drive agent behavior.
  • Tools — reusable HTTP integrations.
  • Workflows — account-level automations.
  • Workflow Variables — variables scoped to a Workflow automation.
  • Flow Variables — variables scoped to an agent's Flow.
  • Intents — NLP triggers inside an agent.
  • Incoming Webhooks — inbound HTTPS endpoints for external systems.
  • AI Models — LLMs and transcription models available to your agents.

Getting started