Skip to main content
GET
/
companies
/
list
List companies
curl --request GET \
  --url https://api.village.do/v1/companies/list \
  --header 'user-identifier: <user-identifier>' \
  --header 'x-access-token: <api-key>'
{
  "data": [
    {
      "linkedin_url": "https://linkedin.com/company/stealth-startup-51",
      "score": 174.2,
      "score_label": "Excellent"
    },
    {
      "domain_name": "peachwiz.com",
      "linkedin_url": "https://linkedin.com/company/peachwiz",
      "score": 79.2,
      "score_label": "Excellent"
    },
    {
      "linkedin_url": "https://linkedin.com/company/wwbn",
      "score": 79.2,
      "score_label": "Excellent"
    },
    {
      "domain_name": "linkedin.com",
      "linkedin_url": "https://linkedin.com/company/linkedin",
      "score": 29.1,
      "score_label": "Excellent"
    },
    {
      "linkedin_url": "https://linkedin.com/company/udacity",
      "score": 28,
      "score_label": "Excellent"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 5,
    "hasNextPage": true
  }
}

Authorizations

x-access-token
string
header
required

JWT token obtained from /users/authorization endpoint

Headers

user-identifier
string
required

Specify the user making the request. This identifier should match the one you used when integrating the user with Village. Not needed when using user token authentication.

Query Parameters

page
integer

Page number for pagination

limit
integer
default:50

Number of results per page

Required range: x <= 1000

Response

Successfully retrieved top companies

data
object[]

Array of top companies ranked by relationship strength

pagination
object
I