# gtm-api > REST API and MCP server for LinkedIn outreach infrastructure: connected accounts, messaging, enrichment, mass actions and webhooks. ## Guides ### Get started - [gtm-api documentation](https://docs.gtm-api.com/index.md): A typed REST API and MCP server for LinkedIn outreach infrastructure: connected accounts, messaging, enrichment, mass actions and webhooks. - [Quickstart](https://docs.gtm-api.com/quickstart.md): Mint an API key and make your first authenticated call. - [Authentication](https://docs.gtm-api.com/authentication.md): API keys, session JWTs and team scoping. ### Concepts - [Envelopes and errors](https://docs.gtm-api.com/concepts/envelopes-and-errors.md): One response wrapper for every success, one error format with a closed 16-code taxonomy. - [Pagination and filtering](https://docs.gtm-api.com/concepts/pagination-and-filtering.md): Cursor paging, typed per-field filters, includes, and how objects travel in query strings. ### Guides - [Run a mass action](https://docs.gtm-api.com/guides/run-a-mass-action.md): Preview a bulk plan, commit it with the consent token, then monitor the run to settlement. - [Receive webhooks](https://docs.gtm-api.com/guides/receive-webhooks.md): Register an endpoint, verify signed deliveries, filter what you receive, and read the delivery log. Includes the retry policy and the auto-disable rule. ## Knowledge Base ### Start here - [Knowledge base](https://docs.gtm-api.com/kb/index.md): How the platform works: accounts and browsers, safety and pacing, finding and enriching people, conversations, billing, and what to do when something breaks. ### Accounts and browsers - [Connect a LinkedIn account](https://docs.gtm-api.com/kb/connect-a-linkedin-account.md): Connect an account in the app, wait out the initial sync, then work with it over the API. The login happens inside a dedicated antidetect browser; no password ever reaches the platform. - [Antidetect browsers and proxies](https://docs.gtm-api.com/kb/antidetect-browsers-and-proxies.md): Every LinkedIn account runs in its own isolated browser profile with a stable fingerprint and its own proxy. What the browser does, how proxies attach, and how to diagnose both. - [Share or transfer a connected account](https://docs.gtm-api.com/kb/account-sharing-and-handover.md): Lend a connected LinkedIn account to another workspace and get it back, or hand ownership over permanently. Covers what the receiving side gets, what happens to the browser and the sync, and every status both sides see. ### Safety and pacing - [Smart limits and warmup](https://docs.gtm-api.com/kb/smart-limits-and-warmup.md): Per-action daily budgets protect every LinkedIn account, and a warmup ramp grows them as a new account proves itself. How budgets, holds and warmup work. - [Sync windows and auto-suspend](https://docs.gtm-api.com/kb/sync-windows-and-auto-suspend.md): Recurring syncs run inside each account's configured hours, idle browsers suspend themselves, and due work wakes them. What is window-gated and what is not. - [Account health](https://docs.gtm-api.com/kb/account-health.md): A sender health summary has four parts: the browser login state (signed out of LinkedIn or not), a warmup score built from six compounding signals, the smart-limit budgets, and two incident logs. What each one records and what to do about it. ### Finding and enriching - [People and company search](https://docs.gtm-api.com/kb/people-and-company-search.md): Run one live page of a LinkedIn, Sales Navigator or Recruiter people or company search: the pasted-URL and structured-filter input styles, how ids are resolved, what a row contains, and what a page costs. - [Find an email or phone number for a profile](https://docs.gtm-api.com/kb/enrichment.md): Run contact enrichment on one LinkedIn profile: what comes back, which of your connected accounts it runs on, and how to read a partial result. - [Collect leads with an auto-scrape](https://docs.gtm-api.com/kb/auto-scrapes.md): Save a LinkedIn or Sales Navigator search as a recurring collector, deduplicate what it finds across runs, and feed the new leads into a standing mass action. ### Conversations - [Inbox and message sync](https://docs.gtm-api.com/kb/inbox-and-message-sync.md): How conversations and messages reach the platform: what the initial backfill imports, how often each surface re-syncs, what realtime push covers, and why a message may not be there yet. - [LinkedIn Recruiter](https://docs.gtm-api.com/kb/recruiter.md): Recruiter is supported on accounts that hold a Recruiter seat: candidate search, the talent inbox, hiring projects and Recruiter InMail. What the seat gives you, and why the session expires every 30 days. ### Workspace and billing - [Workspaces and team members](https://docs.gtm-api.com/kb/workspaces-and-team-members.md): What a workspace owns, how switching between them works, how member access is expressed, what an invite does, and why team members are off on the free plan. - [Billing and plans](https://docs.gtm-api.com/kb/billing-and-plans.md): Sandbox, the forever free plan you start on, how paid accounts are priced, and what happens when a payment fails or a subscription ends. ### Troubleshooting - [Proxy problems](https://docs.gtm-api.com/kb/proxy-troubleshooting.md): LinkedIn will not load, the account keeps hitting verification, the browser stops overnight: how to tell a broken proxy from a lost session or normal auto-suspend, and what to do about each. - [Browser will not start](https://docs.gtm-api.com/kb/browser-troubleshooting.md): The antidetect browser sits in an issue status, the session dies right after starting, or LinkedIn keeps asking to log in. How to read the status, what the platform already did on its own, and when re-login is the only fix. - [Email is not supported yet](https://docs.gtm-api.com/kb/email-is-not-supported-yet.md): Email is not a working channel on this platform yet. What does not work today, why you may still see email mentioned in the API reference, and what to use instead. - [API Reference (274 pages)](https://docs.gtm-api.com/_llms/api-reference.md): Documentation for API Reference. ## MCP ### MCP server - [MCP server](https://docs.gtm-api.com/mcp/overview.md): The same platform, exposed as Model Context Protocol tools an AI agent can call. - [Connect a client](https://docs.gtm-api.com/mcp/connect.md): Add the gtm-api MCP server to Claude, Cursor, VS Code, ChatGPT or any MCP-compatible runtime. - [Agent-native signup and billing](https://docs.gtm-api.com/mcp/agent-signup.md): How an AI agent registers its operator, connects itself, and handles the moment the workspace needs a paid plan. - [Use these docs from your AI tools](https://docs.gtm-api.com/mcp/use-docs-with-ai.md): The documentation has its own MCP endpoint, plus llms.txt and per-page Markdown. ## Changelog ### Changelog - [Changelog](https://docs.gtm-api.com/changelog.md): What's new in the GTM API platform and this documentation. ## OpenAPI Specs - [openapi](/api-reference/linkedin/openapi.yaml) - [openapi](/api-reference/id/openapi.yaml) - [openapi](/api-reference/orchestration/openapi.yaml) > The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages. ## Indexes - [API Reference (274 pages)](https://docs.gtm-api.com/_llms/api-reference.md): Documentation for API Reference. - [API Reference / LinkedIn API (179 pages)](https://docs.gtm-api.com/_llms/api-reference/linked-in-api.md): Documentation for API Reference / LinkedIn API.