Output Response - Cleaner APIs

Detailed information on the output responses returned by the Cleaner APIs

Company Cleaner API Response

Here is an example response from the Company Cleaner API:

{
  "name": "university of california, los angeles",
  "type": "post-secondary institution",
  "id": "72978d72-275a-49c8-b9b9-f227ccfb1361",
  "location": {
    "name": "los angeles, california, united states",
    "locality": "los angeles",
    "region": "california",
    "country": "united states",
    "continent": "north america"
  },
  "linkedin_url": "linkedin.com/school/ucla",
  "facebook_url": null,
  "twitter_url": null,
  "linkedin_id": "17950",
  "website": "ucla.edu",
  "domain": "ucla.edu"
}

If a matching company is found, a 200 response returns along with the company record in JSON format. The schema of the response matches the company schema in the Person record. If a matching company is not found, a 404 returns.

For querying the Company schema, you can use the the following field mapping:

company fieldperson fields
idjob_company_id, experience.company.id

Location Cleaner API Response

Here is an example response from the Location Cleaner API:

{
  "name": "portland, oregon, united states",
  "locality": "portland",
  "region": "oregon",
  "subregion": "multnomah county",
  "country": "united states",
  "continent": "north america",
  "type": "locality",
  "geo": "45.52,-122.67",
}

If the location is successfully parsed, a 200 response returns along with the parsed location in JSON format. The schema of the response matches the location schema in the Person record. If a matching company is not found, a 404 returns.

For querying the location schema, you can use the the following field mapping:

location fieldperson fields
namejob_company_location_name, location_name, location_names, street_addresses.name, experience.location_names, experience.company.location.name, education.school.location.name

School Cleaner API Response

Here is an example response from the School Cleaner API:

{
  "name": "university of california, los angeles",
  "type": "post-secondary institution",
  "id": "72978d72-275a-49c8-b9b9-f227ccfb1361",
  "location": {
    "name": "los angeles, california, united states",
    "locality": "los angeles",
    "region": "california",
    "country": "united states",
    "continent": "north america"
  },
  "linkedin_url": "linkedin.com/school/ucla",
  "facebook_url": null,
  "twitter_url": null,
  "linkedin_id": "17950",
  "website": "ucla.edu",
  "domain": "ucla.edu"
}

If a matching school is found, a 200 response returns along with the cleaned school in JSON format. The schema of the response matches the school schema in the Person record. If a matching school is not found a 404 returns.

For querying the school schema, you can use the the following field mapping:

school fieldperson field
ideducation.school.id

Did this page help you?