Skip to main content
POST
/
api
/
inhersight
/
companies
/
scores
/inhersight/companies/scores
curl --request POST \
  --url https://api.anysite.io/api/inhersight/companies/scores \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "company": "<string>",
  "timeout": 300
}
'
[
  {
    "id": 123,
    "url": "<string>",
    "@type": "InhersightCompanyScores",
    "alias": "<string>",
    "groupings": [],
    "scores": []
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
company
string
required

Company alias (the URL segment, e.g. 'aro-homes'), numeric company id, or a full company profile URL. Resolve the alias via /inhersight/companies/search if you only have the name.

Minimum string length: 1
Pattern: ^(?:https?://[^\s]+|[A-Za-z0-9][A-Za-z0-9._-]*)$
Examples:

"aro-homes"

"297729"

"https://www.inhersight.com/company/aro-homes"

​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500

Response

Successful Response

​
id
integer
required
​
url
string
required
​
@type
string
default:InhersightCompanyScores
​
alias
string | null
​
groupings
object[]
​
scores
object[]