@font-face {
  font-family: "Roobert Pro";
  src: url("https://cdn.prod.website-files.com/6194c0787e082a13b6aa29b4/6787a42badc1033730fa2960_RoobertPRO-SemiBold.woff2");
  font-weight:600;
}

table th {
  text-align:left;
} 

p {
  line-height: 1.6;
}

.font-medium {
  font-family:"Roobert Pro";
  font-weight:600 !important;
}

Diagnose and resolve API errors with ease.

Errors

The Swarm

Seamless integration and powerful data access to The Swarm database.

Introduction

Access to the API is authenticated using an API key mechanism.

Authentication

Optimize API usage with rate limits and retry guidance.

Rate limiting

Overview of the data model representing a profile returned by the Fetch endpoint

Profile

Below is the comprehensive OpenSearch field mapping for profile data.

OpenSearch Profile Mappings

Overview of the data model representing a record returned by the Fetch Company endpoint.

Company

Below is the comprehensive OpenSearch field mapping for company data.

OpenSearch Company Mappings

Search endpoint

Fetch endpoint

The Search Profiles endpoint facilitates searching for profiles within the profile database based on their attributes. Utilizing OpenSearch as the underlying database technology, this endpoint accepts requests with OpenSearch domain-specific language (DSL), enabling powerful and flexible search queries.

Search Profiles v2

The Fetch endpoint within the API facilitates the retrieval of specific profiles from the database based on their unique identifiers (profile IDs or LinkedIn usernames). This endpoint is designed to provide detailed information about individual profiles stored in the database, allowing users to access profile connections, lists, notes, and tags. 

Fetch Profile v2

This endpoint provides a powerful tool for searching our internal database of Companies. As our database primarily consists of employees, this functionality enables users to discover company information efficiently. By utilizing the Search Company endpoint, you can query our database to find relevant Companies and obtain their respective IDs for further exploration or integration with other functionalities.

Search Company

This endpoint offers seamless access to detailed information about Companies stored in our internal database. Whether you're looking to retrieve specific company details for analysis, integration, or other purposes, the Fetch Company endpoint provides a straightforward solution. Simply provide the company ID, and this endpoint will return comprehensive data about the specified Company

Status code		Description
200	OK	Everything worked as expected.
400	Bad Request	The request was unacceptable, often due to missing a required parameter.
401	Unauthorized	No valid API key provided in the `x-api-key` header.
402	Request Failed	The parameters were valid but the request failed.
403	Forbidden	The API key doesn’t have permissions to perform the request.
404	Not Found	The requested resource doesn’t exist.
409	Conflict	The request conflicts with another request (perhaps due to using the same idempotent key).
429	Too Many Requests	Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.
500, 502, 503, 504	Server Errors	Something went wrong on The Swarm end. (These are rare.)

Getting Started

Models

Examples

Errors