Input Parameters - Cleaner APIs

Detailed information on the input parameters used for the Cleaner APIs

Company Cleaner API Parameters (/company/clean)

While all parameters are optional, we require a non-ambiguous match. This means that you must input a name OR website OR profile.

name

Parameter Name

Required

Description

Example

name

No

The name of the company that you want to identify. Unformatted strings with arbitrary capitalizations, leading and trailing whitespaces, and so forth are accepted.

People data Labs

profile

Parameter Name

Required

Description

Example

profile

No

The social profile URL of the company that you want to identify. Unformatted URLs with arbitrary capitalizations, leading and trailing whitespaces, and so forth are accepted.

linkedin.com/company/google

website

Parameter Name

Required

Description

Example

website

No

The website of the company that you want to identify. Unformatted URLs with arbitrary capitalizations, leading and trailing whitespaces, and so forth are accepted.

www.peopledatalabs.com

pretty

Parameter Name

Required

Description

Example

pretty

No

Whether the output should have human-readable indentation.

True

api_key

Parameter Name

Required

Description

Example

api_key

No

Not required as part of the request parameters, but if it is not provided here, then it must be provided in the headers using the x-api-key field. For more information, see the Authentication page.

Location Cleaner API (/location/clean)

location

Parameter Name

Required

Description

Example

location

Yes

The name of the location that you want to identify. Unformatted locations with arbitrary capitalizations, leading and trailing whitespaces, and so forth are accepted.

San Francisco

pretty

Parameter Name

Required

Description

Example

pretty

No

Whether the output should have human-readable indentation.

True

api_key

Parameter Name

Required

Description

Example

api_key

No

Not required as part of the request parameters, but if it is not provided here, then it must be provided in the headers using the x-api-key field. For more information, see the Authentication page.

School Cleaner API (/school/clean)

While all parameters are optional, we require a non-ambiguous match. This means that you must input a name OR website OR profile.

name

Parameter Name

Required

Description

Example

name

No

The name of the company that you want to identify. Unformatted strings with arbitrary capitalizations, leading and trailing whitespaces, and so forth are accepted.

People data Labs

profile

Parameter Name

Required

Description

Example

profile

No

The social profile URL of the company that you want to identify. Unformatted URLs with arbitrary capitalizations, leading and trailing whitespaces, and so forth are accepted.

linkedin.com/company/google

website

Parameter Name

Required

Description

Example

website

No

The website of the company that you want to identify. Unformatted URLs with arbitrary capitalizations, leading and trailing whitespaces, and so forth are accepted.

www.peopledatalabs.com

pretty

Parameter Name

Required

Description

Example

pretty

No

Whether the output should have human-readable indentation.

True

api_key

Parameter Name

Required

Description

Example

api_key

No

Not required as part of the request parameters, but if not provided here, then it must be provided in the headers using the x-api-key field. For more information, see the Authentication page.



Did this page help you?