GET
/
companies
/
top
Get Top Companies
curl --request GET \
  --url https://api.village.do/v1/companies/top \
  --header 'secret-key: <api-key>' \
  --header 'user-identifier: <user-identifier>'
{
  "data": [
    {
      "linkedin_url": "https://linkedin.com/company/stealth-startup-51",
      "score": 174.2,
      "score_label": "Excellent"
    },
    {
      "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"
    },
    {
      "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

​
secret-key
string
header
required

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.

Query Parameters

​
page
integer

Page number for pagination

​
limit
integer
default:50

Number of results per page

Required range: x <= 1000

Response

200
application/json

Successfully retrieved top companies

The response is of type object.