Skip to main content
POST
/
people
/
sort
Sort People
curl --request POST \
  --url https://api.village.do/v1/people/sort \
  --header 'Content-Type: application/json' \
  --header 'user-identifier: <user-identifier>' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "people": [
    "https://linkedin.com/in/gavin-belson",
    "https://linkedin.com/in/peter-gregory",
    "https://linkedin.com/in/big-head"
  ]
}
'
[
  {
    "url": "https://linkedin.com/in/big-head",
    "score": 9,
    "score_label": "Excellent"
  },
  {
    "url": "https://linkedin.com/in/peter-gregory",
    "score": 8.5,
    "score_label": "Excellent"
  },
  {
    "url": "https://linkedin.com/in/gavin-belson",
    "score": 7,
    "score_label": "Very Good"
  }
]

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
​
people
string[]
required

Array of LinkedIn URLs

Example:
[
  "https://linkedin.com/in/gavin-belson",
  "https://linkedin.com/in/peter-gregory",
  "https://linkedin.com/in/big-head"
]

Response

200 - application/json

Sorted list of people with warmth 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

Example:
[
  {
    "url": "https://linkedin.com/in/big-head",
    "score": 9,
    "score_label": "Excellent"
  },
  {
    "url": "https://linkedin.com/in/peter-gregory",
    "score": 8.5,
    "score_label": "Excellent"
  },
  {
    "url": "https://linkedin.com/in/gavin-belson",
    "score": 7,
    "score_label": "Very Good"
  }
]