Skip to main content
POST
/
v2
/
companies
/
paths
Get Company Paths
curl --request POST \
  --url https://api.village.do/v2/companies/paths \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "acme.com"
}
'
{
  "data": {
    "company": {
      "name": "<string>",
      "domain": "<string>",
      "linkedin_url": "<string>",
      "village_url": "<string>"
    },
    "summary": {
      "score": 123,
      "score_label": "<string>",
      "description": "<string>"
    },
    "target_people": [
      {
        "target": {
          "first_name": "<string>",
          "last_name": "<string>",
          "full_name": "<string>",
          "id": "<string>",
          "identity_id": "<string>",
          "avatar": "<string>",
          "linkedin_identifier": "<string>",
          "linkedin_url": "<string>",
          "title": "<string>",
          "village_person_url": "<string>"
        },
        "paths": [
          {
            "type": "intro",
            "summary": {
              "score": 123,
              "score_label": "<string>",
              "description": "<string>"
            },
            "starters": [
              {
                "profile": {
                  "first_name": "<string>",
                  "last_name": "<string>",
                  "linkedin_url": "<string>",
                  "headline": "<string>"
                },
                "score": 123,
                "score_label": "<string>",
                "score_description": "<string>",
                "score_meta": [
                  {
                    "title": "<string>",
                    "description": "<string>"
                  }
                ]
              }
            ],
            "introducer": {
              "profile": {
                "first_name": "<string>",
                "last_name": "<string>",
                "linkedin_url": "<string>",
                "headline": "<string>"
              },
              "score": 123,
              "score_label": "<string>",
              "score_meta": [
                {
                  "title": "<string>",
                  "description": "<string>"
                }
              ]
            }
          }
        ],
        "summary": {
          "score": 123,
          "score_label": "<string>",
          "description": "<string>"
        },
        "count": 123
      }
    ],
    "count": 123
  },
  "metadata": {
    "request_id": "<string>"
  }
}

Authorizations

Authorization
string
header
required

JWT token obtained from authentication endpoint

Body

application/json

Company identifier - provide one of: domain, linkedin_url, or url

domain
string
required

Company domain (normalized, without www prefix)

Minimum string length: 1
Example:

"acme.com"

Response

Company paths found successfully

data
object
required

Company paths response with connection information

metadata
object
required