Skip to main content
POST
/
companies
/
sort
Sort Companies
curl --request POST \
  --url https://api.village.do/v1/companies/sort \
  --header 'Content-Type: application/json' \
  --header 'user-identifier: <user-identifier>' \
  --header 'x-access-token: <api-key>' \
  --data '{
  "companies": [
    "https://linkedin.com/company/hooli",
    "https://linkedin.com/company/aviato"
  ]
}'
[
  {
    "url": "https://linkedin.com/company/hooli",
    "score": 9,
    "score_label": "Excellent"
  },
  {
    "url": "https://linkedin.com/company/aviato",
    "score": 8.5,
    "score_label": "Excellent"
  }
]

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.

Body

application/json
​
companies
string[]
required

Array of company LinkedIn URLs or domain URLs

Example:
[
  "https://linkedin.com/company/hooli",
  "https://linkedin.com/company/aviato"
]

Response

200 - application/json

Successfully retrieved sorted list of companies with relationship scores

​
url
string

LinkedIn URL or domain URL that was provided in the request

​
score
number

Relationship strength score

Example:

8.5

​
score_label
enum<string>

Human-readable label for the relationship strength

Available options:
Excellent,
Very Good,
Good,
Okay,
Maybe
Example:

"Excellent"

​
error
string

Error message if the URL couldn't be processed

⌘I