GET
/
companies
/
paths
/
{url}
curl --request GET \
  --url https://api.village.do/v1/companies/paths/{url} \
  --header 'secret-key: <api-key>'
{
  "target_people": [
    {
      "target": {
        "profile": {
          "village_id": "vill_999abc",
          "first_name": "Gavin",
          "last_name": "Belson",
          "linkedin_url": "https://linkedin.com/in/gavin-belson",
          "headline": "CEO at Hooli"
        }
      },
      "count": 1,
      "summary": {
        "score": 8,
        "score_label": "Excellent",
        "description": "🟢 Erlich Bachman → Peter Gregory → Gavin Belson (CEO)"
      },
      "paths": [
        {
          "type": "intro",
          "starters": [
            {
              "profile": {
                "village_id": "vill_789xyz",
                "first_name": "Erlich",
                "last_name": "Bachman",
                "linkedin_url": "https://linkedin.com/in/erlich-bachman",
                "headline": "Founder at Aviato"
              },
              "score": 8.5,
              "score_label": "Excellent",
              "score_description": "🟢 Erlich can make a strong introduction"
            }
          ],
          "introducer": {
            "profile": {
              "village_id": "vill_456def",
              "first_name": "Peter",
              "last_name": "Gregory",
              "linkedin_url": "https://linkedin.com/in/peter-gregory",
              "headline": "Founder at Raviga Capital"
            },
            "score": 8.5,
            "score_label": "Excellent",
            "score_description": "🟢 Erlich can make a strong introduction"
          },
          "summary": {
            "score": 8.5,
            "score_label": "Excellent",
            "description": "🟢 Erlich can intro via Peter Gregory (Lead investor)"
          }
        }
      ]
    },
    {
      "target": {
        "profile": {
          "village_id": "vill_888xyz",
          "first_name": "Nelson",
          "last_name": "Bighetti",
          "linkedin_url": "https://linkedin.com/in/big-head",
          "headline": "CTO at Hooli"
        }
      },
      "count": 1,
      "summary": {
        "score": 9,
        "score_label": "Excellent",
        "description": "🟢 Richard Hendricks (direct)"
      },
      "paths": [
        {
          "type": "direct",
          "introducer": {
            "profile": {
              "village_id": "vill_123abc456",
              "first_name": "Richard",
              "last_name": "Hendricks",
              "linkedin_url": "https://linkedin.com/in/richard-hendricks",
              "headline": "CEO at Pied Piper"
            },
            "score": 9,
            "score_label": "Excellent",
            "score_description": "🟢 You can reach out directly (college roommate)"
          },
          "starters": [
            {
              "profile": {
                "village_id": "vill_123abc456",
                "first_name": "Richard",
                "last_name": "Hendricks",
                "linkedin_url": "https://linkedin.com/in/richard-hendricks",
                "headline": "CEO at Pied Piper"
              },
              "score": 9,
              "score_label": "Excellent",
              "score_description": "🟢 You can reach out directly (college roommate)"
            }
          ],
          "summary": {
            "score": 9,
            "score_label": "Excellent",
            "description": "🟢 You can reach out directly (college roommate)"
          }
        }
      ]
    }
  ],
  "count": 2,
  "summary": {
    "score": 8.5,
    "score_label": "Excellent",
    "description": "🟢 Direct path to Nelson Bighetti (CTO), 🟢 Intro path to Gavin Belson (CEO) via Peter Gregory"
  }
}

Authorizations

secret-key
string
header
required

Headers

user-identifier
string

Specify the user making the request. This identifier should match the one you used when integrating the user with Village.

Path Parameters

url
string
required

LinkedIn URL or domain URL of the target company (URL encoded)

Response

200 - application/json
Successfully retrieved company paths
target_people
object[]

Complete response for paths to a person

Example:
[
  {
    "target": {
      "profile": {
        "village_id": "vill_999abc",
        "first_name": "Gavin",
        "last_name": "Belson",
        "linkedin_url": "https://linkedin.com/in/gavin-belson",
        "headline": "CEO at Hooli"
      }
    },
    "count": 1,
    "summary": {
      "score": 8,
      "score_label": "Excellent",
      "description": "🟢 Erlich Bachman → Peter Gregory → Gavin Belson (CEO)"
    },
    "paths": [
      {
        "type": "intro",
        "starters": [
          {
            "profile": {
              "village_id": "vill_789xyz",
              "first_name": "Erlich",
              "last_name": "Bachman",
              "linkedin_url": "https://linkedin.com/in/erlich-bachman",
              "headline": "Founder at Aviato"
            },
            "score": 8.5,
            "score_label": "Excellent",
            "score_description": "🟢 Erlich can make a strong introduction"
          }
        ],
        "introducer": {
          "profile": {
            "village_id": "vill_456def",
            "first_name": "Peter",
            "last_name": "Gregory",
            "linkedin_url": "https://linkedin.com/in/peter-gregory",
            "headline": "Founder at Raviga Capital"
          },
          "score": 8.5,
          "score_label": "Excellent",
          "score_description": "🟢 Erlich can make a strong introduction"
        },
        "summary": {
          "score": 8.5,
          "score_label": "Excellent",
          "description": "🟢 Erlich can intro via Peter Gregory (Lead investor)"
        }
      }
    ]
  },
  {
    "target": {
      "profile": {
        "village_id": "vill_888xyz",
        "first_name": "Nelson",
        "last_name": "Bighetti",
        "linkedin_url": "https://linkedin.com/in/big-head",
        "headline": "CTO at Hooli"
      }
    },
    "count": 1,
    "summary": {
      "score": 9,
      "score_label": "Excellent",
      "description": "🟢 Richard Hendricks (direct)"
    },
    "paths": [
      {
        "type": "direct",
        "introducer": {
          "profile": {
            "village_id": "vill_123abc456",
            "first_name": "Richard",
            "last_name": "Hendricks",
            "linkedin_url": "https://linkedin.com/in/richard-hendricks",
            "headline": "CEO at Pied Piper"
          },
          "score": 9,
          "score_label": "Excellent",
          "score_description": "🟢 You can reach out directly (college roommate)"
        },
        "starters": [
          {
            "profile": {
              "village_id": "vill_123abc456",
              "first_name": "Richard",
              "last_name": "Hendricks",
              "linkedin_url": "https://linkedin.com/in/richard-hendricks",
              "headline": "CEO at Pied Piper"
            },
            "score": 9,
            "score_label": "Excellent",
            "score_description": "🟢 You can reach out directly (college roommate)"
          }
        ],
        "summary": {
          "score": 9,
          "score_label": "Excellent",
          "description": "🟢 You can reach out directly (college roommate)"
        }
      }
    ]
  }
]
count
integer

Total number of people found

Example:

2

summary
object