v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Companies by Extended Field Values

Fetches companies using the first few values of an extended field value provided.

get/companies/extendedFieldSearch

Query parameters

extendedFieldNamestring required

Name of the extended field by which companies need to be fetched.

qstring required

The first few characters of the extended field value. Pass at least 3 characters. For example, ?extendedFieldName=city&q=ban fetches all the companies that has the city name starting with Ban.

limitinteger

Number of results to relative.

status'ACTIVE' | 'INACTIVE'

Filter companies by status.

sortBy'createdDate'

Always sort results by created date.

sortOrder'asc' | 'desc'

Sort the results in ascending or descending order of the chosen soryBy.

offsetinteger

Number of rows to be ignored from the top (pagination).