---
title: "Network Mapper (Partner) — v3"
method: POST
path: "/v3/network-mapper"
tags: ["network-mapper"]
---

# Network Mapper (Partner) — v3

`POST /v3/network-mapper`

Partner-permission endpoint for mapping connections across the partner network. Calls from API keys not tied to a team with the partner permission in Stripe return 403 Forbidden. Costs 1 credit per non-empty response.

## Request body

- object
  - `query` object, required — Search query in the [ElasticSearch Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html) format. [Find mapping here](https://docs.theswarm.com/docs/mappings/profile-v2)
  - `mapping_company_website` string, required — Website of the company to map network for
  - `callback_url` string — URL to call when async mapping completes

## Response `200`

Mapping data returned immediately

- object
  - `items` NetworkMapperItem[], required
    - `profile` NetworkMapperProfile
      - `id` string, uuid
      - `full_name` string, required
      - `current_title` string
      - `linkedin_url` string
      - `work_email` string
      - `current_company_name` string
      - `current_company_website` string
    - `connections` NetworkMapperConnection[]
      - `connector_id` string, uuid
      - `connector_name` string
      - `connector_linkedin_url` string
      - `connector_current_title` string
      - `connector_current_company_name` string
      - `connection_strength_normalized` integer
      - `connection_strength` number, float
      - `manual_strength` number, float
      - `sources` NetworkMapperConnectionSource[]
        - `origin` 'linkedin_connection' | 'work_overlap' | 'email_contact' | 'calendar_events' | 'manual_import' | 'education_overlap' | 'shared_investor', required
        - `shared_company` string — Name of the shared company from work overlap
        - `shared_company_id` string, uuid — ID of the shared company from work overlap
        - `shared_company_website` string — Website of the shared company from work overlap
        - `shared_company_linkedin_slug` string — Linkedin Slug of the shared company from work overlap
        - `overlap_start_date` string — Start Date of work overlap
        - `overlap_end_date` string — End Date of work overlap
        - `overlap_duration_months` integer — Months Duration of work overlap
        - `shared_school` string — Name of school from education overlap
        - `shared_major` string — Name of major from education overlap
        - `graduation_year` string — Graduation year from education overlap
        - `investor` string — Name of common investor from investor overlap
        - `portfolio_company` string — Name of portfolio company from investor overlap
  - `count` integer, required
  - `total_count` integer, required

## Other responses

- `202` — Mapping task started; poll /v3/network-mapper/status with the returned task_id
- `400` — Bad request
- `401` — Unauthorized
- `402` — Payment required - the team's API credit allowance has been exceeded
- `403` — Forbidden — the API key is not tied to a team with partner permission.
- `404` — Company not found for the given mapping_company_website
- `5XX` — Unexpected error

---

[API](https://skmtc.net/theswarm/apis/swarm-api.md) · [All operations](https://skmtc.net/theswarm/apis/swarm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/theswarm/swarm-api/versions/55bbdd2aa713/schema)