v5

latestOpenAPI 3.0.3raw.githubusercontent.com2024-10-302120469.4 KB
Cleaner Endpoints

/school/clean

post/v5/school/clean

Request body

namestring

The name of the school

websitestring

A website the school uses

profilestring

A social profile used by the school (e.g. LinkedIn/Facebook/Twitter)

prettyboolean

Whether the output should have human-readable indentation

Example request

{
  "name": "Univeristy of Colorado Denver",
  "website": "www.ucdenver.edu",
  "profile": "www.linkedin.com/school/university-of-colorado-denver"
}

Response

School Found

idstring

Our current NOT PERSISTENT ids that tie company data to the canonical data

namestring

The name associated with the school

websitestring

The website associated with the school, could include subdomains

domainstring

The website associated with the school

type'primary school' | 'post-secondary institution' | 'secondary school'

The type of school

linkedin_urlstring

The linkedin url associated with the school

linkedin_idstring

The linkedin ID associated with the school

facebook_urlstring

The facebook url associated with the school

twitter_urlstring

The twitter url associated with the school