# The Swarm

> Developer documentation for The Swarm API, MCP server, and integrations. Access 500M+ professional profiles, 50M+ companies, relationship intelligence, job changes, and fundraising data through REST endpoints, flat files, and MCP-compatible tools.

- [Introduction](https://docs.theswarm.com/docs/getting-started/introduction.md): Seamless integration and powerful data access to The Swarm database.
- [Quickstart](https://docs.theswarm.com/docs/getting-started/quickstart.md): Welcome to The Swarm API implementation guide.
- [Definitions](https://docs.theswarm.com/docs/getting-started/definitions.md): The Swarm API definitions outline how profiles, companies, connections, connectors, and teams are structured and enriched to map relationship networks and surface trusted connection paths.
- [Profile Endpoint Overview](https://docs.theswarm.com/docs/enrichment-data/profile/overview.md): Overview of the data model representing a profile returned by the Fetch endpoint
- [OpenSearch Profile Mappings (v3)](https://docs.theswarm.com/docs/enrichment-data/profile/mappings-v3.md): OpenSearch field mapping for v3 profile data.
- [Company Endpoint Overview](https://docs.theswarm.com/docs/enrichment-data/company/overview.md): Overview of the data model representing a record returned by the Fetch Company endpoint.
- [OpenSearch Company Mappings (v3)](https://docs.theswarm.com/docs/enrichment-data/company/mappings-v3.md): OpenSearch field mapping for v3 company data.
- [Relationships](https://docs.theswarm.com/docs/intelligence/relationships.md): Explore your team's network. The Relationships endpoint queries connection data using OpenSearch DSL and returns the people connected to your team, with full connection details.
- [Network Mapper (for Partners)](https://docs.theswarm.com/docs/intelligence/network-mapper.md): The Network Mapper endpoint builds an entire relationship graph for a target company. Partner permission required.
- [Daily Job Changes](https://docs.theswarm.com/docs/signals/daily-job-changes.md): How to query daily job-change signals (new roles, promotions, departures) from The Swarm API.
- [Overview](https://docs.theswarm.com/docs/flat-files/overview.md): Flat files are bulk data dumps of The Swarm's entire proprietary database including all fields described in this API documentation, meant for customers who want to host the data themselves and ingest it directly. Flat files give you faster access to the data, and more flexibility on your end.
- [Overview](https://docs.theswarm.com/docs/mcp/overview.md): Connect The Swarm to Claude, ChatGPT, and other AI assistants that support the Model Context Protocol (MCP), and ask questions about people, companies, and your network in plain language.
- [Connect in Claude](https://docs.theswarm.com/docs/mcp/connect-claude.md): Connect The Swarm to Claude as a custom MCP connector. Sign in with your Swarm account — no API keys or terminal commands required.
- [Connect in ChatGPT](https://docs.theswarm.com/docs/mcp/connect-chatgpt.md): Connect The Swarm to ChatGPT as a custom MCP server. Enable Developer mode, then sign in with your Swarm account.
- [Connect with an API key](https://docs.theswarm.com/docs/mcp/connect-api-key.md): Connect The Swarm MCP from any client that supports custom HTTP headers, using your team's API key instead of OAuth.
- [Tools & Prompts](https://docs.theswarm.com/docs/mcp/tools-and-prompts.md): How to prompt your assistant to get the most out of The Swarm MCP, and a reference for all nine tools it can call.
- [Add Connector](https://docs.theswarm.com/docs/team-management/connector.md): Add one or more connector accounts to an existing team via API
- [Create Team](https://docs.theswarm.com/docs/team-management/team.md): This endpoint allows customers with partner API key to create new teams and access them with a single API key
- [Canonical Values ](https://docs.theswarm.com/docs/miscellaneous/canonical-values.md): Simplify finding relevant data with standardized values
- [Data Subject Requests](https://docs.theswarm.com/docs/miscellaneous/data-subject-requests.md): Automate profile data erasure requests using The Swarm DSR API.
- [Search endpoint](https://docs.theswarm.com/docs/examples/search-endpoint.md): Example OpenSearch DSL queries for the Search Profiles and Search Companies endpoints.
- [Query operators](https://docs.theswarm.com/docs/examples/query-operators.md): How to combine AND/OR logic, exact phrases, and other OpenSearch DSL operators when searching profiles and companies.
- [Fetch endpoint](https://docs.theswarm.com/docs/examples/fetch-endpoint.md): Example requests for the Fetch Profile and Fetch Company endpoints.
- [Relationships endpoint](https://docs.theswarm.com/docs/examples/relationships-endpoint.md): Example OpenSearch DSL queries for the Relationships endpoint.
- [Child Team Relationships](https://docs.theswarm.com/docs/examples/partner-child-teams.md): Use partner child teams to run Relationships queries against a curated subset of connectors — a targeted network for ABM, sales pods, or region-specific outreach.
- [Job changes endpoint](https://docs.theswarm.com/docs/examples/job-changes-endpoint.md): Example OpenSearch DSL queries for retrieving daily job changes via the Search Profiles endpoint.
- [Profile Sample Data](https://docs.theswarm.com/docs/enrichment-data/profile/sample-data.md): Example JSON response payload for a profile record returned by the v3 Fetch Profile endpoint.
- [Company Sample Data](https://docs.theswarm.com/docs/enrichment-data/company/sample-data.md): Example JSON response payload for a company record returned by the v3 Fetch Company endpoint.
- [API Query Tester](https://docs.theswarm.com/docs/examples/api-query-tester.md): Test your OpenSearch DSL queries against the Swarm API and see real results.
- [API Reference](https://docs.theswarm.com/docs/api-reference/introduction.md)
- [Errors](https://docs.theswarm.com/docs/api-reference/errors.md): Diagnose and resolve API errors with ease.
- [Rate limiting](https://docs.theswarm.com/docs/api-reference/rate-limiting.md): Optimize API usage with rate limits and retry guidance.
- [Pagination](https://docs.theswarm.com/docs/api-reference/pagination.md): Handling queries with large responses
- [Credits & Usage](https://docs.theswarm.com/docs/api-reference/credits-usage.md): How API credits are counted and how to retrieve your team's current usage.
- [Search Profiles](https://docs.theswarm.com/docs/endpoints/v3/search-profiles.md): Search for profiles using OpenSearch DSL queries. Returns a list of profile IDs that can be passed to the Fetch Profile endpoint.
- [Fetch Profile](https://docs.theswarm.com/docs/endpoints/v3/fetch-profile.md): Retrieve detailed information about specific profiles by their unique identifiers.
- [Search Companies](https://docs.theswarm.com/docs/endpoints/v3/search-companies.md): Search the company database using OpenSearch DSL queries. Returns a list of company IDs that can be passed to the Fetch Company endpoint.
- [Fetch Company](https://docs.theswarm.com/docs/endpoints/v3/fetch-company.md): Retrieve detailed information about companies by their unique identifiers.
- [Relationships](https://docs.theswarm.com/docs/endpoints/v3/relationships.md): Find connected profiles with their connection details. Renamed from Network Mapper in v3.
- [Add Connector](https://docs.theswarm.com/docs/endpoints/v3/add-connector.md): Add one or more LinkedIn profiles as connectors to your team.
- [Create Team](https://docs.theswarm.com/docs/endpoints/v3/create-team.md): Create a new child team under your partner account.
- [Network Mapper](https://docs.theswarm.com/docs/endpoints/v3/network-mapper.md): Map connections across the partner network. Partner permission required.
- [Network Mapper Status](https://docs.theswarm.com/docs/endpoints/v3/network-mapper-status.md): Poll the status of a long-running Network Mapper (Partner) task.
- [API Query Builder](https://docs.theswarm.com/docs/examples/api-query-builder.md): Convert natural language into OpenSearch DSL and can run it against the Swarm API, delivering both the query and live results in one interface.
- [FAQ](https://docs.theswarm.com/docs/getting-started/faq.md): Common questions about The Swarm API — v3 migration, data coverage, queries, credits, and data quality.

## OpenAPI Specs

- [openapi](/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.