# Frontline Documentation

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](/reference/openapi)**.

## 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`.

## Read next

**Getting started**

- **[Getting started](/docs/getting-started)** — your first authenticated request, step by step.
- **[Authentication](/docs/authentication)** — `USER` vs `GENERAL` keys and which endpoints need which.
- **[Rate limits](/docs/rate-limits)** — current quotas and how to handle `429` responses.
- **[Errors](/docs/errors)** — error envelope, status codes, and recommended client handling.


**Core Concepts**

- **[Standard Objects](/docs/concepts/standard-objects)** — the built-in CRM objects: [People](/docs/concepts/standard-objects/people), [Companies](/docs/concepts/standard-objects/companies), [Deals](/docs/concepts/standard-objects/deals), [Tickets](/docs/concepts/standard-objects/tickets).
- **[Objects](/docs/concepts/objects)** — CRM entities with record types and relations.
- **[Field Types](/docs/concepts/field-types)** — every field type, its metadata, defaults, and unique constraints.
- **[Querying and Filtering](/docs/concepts/querying)** — JSON Query DSL to filter, search, and sort CRM objects and custom tables.
- **[Record Types](/docs/concepts/record-types)** — categories within an Object.
- **[Tables](/docs/concepts/tables)** — spreadsheet-style datasets.
- **[Agents](/docs/concepts/agents)** — the AI assistants you ship.
- **[Agent Playbooks](/docs/concepts/agent-playbooks)** — reusable SOPs assigned to agents.
- **[Agent Channels](/docs/concepts/agent-channels)** — WhatsApp, Instagram, and Messenger bindings.
- **[Flows](/docs/concepts/flows)** — conversation graphs that drive agent behavior.
- **[Tools](/docs/concepts/tools)** — reusable HTTP integrations.
- **[Workspace Connectors](/docs/concepts/workspace-connectors)** — account-scoped connected accounts (Gmail, Slack, Salesforce, …).
- **[Workflows](/docs/concepts/workflows)** — account-level automations.
- **[Workflow Variables](/docs/concepts/workflow-variables)** — variables scoped to a Workflow automation.
- **[Flow Variables](/docs/concepts/flow-variables)** — variables scoped to an agent's Flow.
- **[Intents](/docs/concepts/intents)** — NLP triggers inside an agent.
- **[Incoming Webhooks](/docs/concepts/incoming-webhooks)** — inbound HTTPS endpoints for external systems.
- **[AI Models](/docs/concepts/ai-models)** — LLMs and transcription models available to your agents.
- **[Max Meetings](/docs/concepts/max/meetings)** — notetaker recordings, transcripts, and AI notes.
- **[Max Tasks](/docs/concepts/max/tasks)** — scheduled and event-triggered Max automations.
- **[Max Playbooks](/docs/concepts/max/playbooks)** — instruction sets for the personal Max assistant.
- **[Max Proactive](/docs/concepts/max/proactive)** — when Max may reach out unprompted.
- **[Max Connectors](/docs/concepts/max/connectors)** — the calling user's own connected accounts.
- **[Data & Sync](/docs/concepts/admin/data-and-sync)** — account defaults for turning activity into CRM records.
- **[Studio Billing](/docs/concepts/admin/studio-billing)** — credits, agents, and plan limits.
- **[Max Billing](/docs/concepts/max/billing)** — Max seats and capability licenses.