Company
Performs a text search on companies and returns the matching results
get/v1/companies/search
Request
- Base URLhttps://api.infoset.app (the document declares no server; this is the origin it was published from)
- Auth
- HTTP bearer
- or API key in header X-Api-Key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Querystring required
Fieldsstring
SearchInActivitiesboolean
Executes the search in activities (notes, emails, calls, meetings, etc.)
SearchType0 | 1 | 2
<p>Enum values:</p><ul><li><i>0 = Smart</i></li><li><i>1 = Exact</i></li><li><i>2 = Fuzzy</i></li></ul>
Search type: Smart (default), Exact, Fuzzy<p>Enum values:</p><ul><li><i>0 = Smart</i></li><li><i>1 = Exact</i></li><li><i>2 = Fuzzy</i></li></ul>
Fuzziness0 | 1 | 2 | 3
<p>Enum values:</p><ul><li><i>0 = None</i></li><li><i>1 = Auto</i></li><li><i>2 = Low</i></li><li><i>3 = High</i></li></ul>
Fuzzy tolerance: None (default), Auto, Low (1), High (2)<p>Enum values:</p><ul><li><i>0 = None</i></li><li><i>1 = Auto</i></li><li><i>2 = Low</i></li><li><i>3 = High</i></li></ul>
ViewType0 | 1
<p>Enum values:</p><ul><li><i>0 = List</i></li><li><i>1 = Kanban</i></li></ul>
<p>Enum values:</p><ul><li><i>0 = List</i></li><li><i>1 = Kanban</i></li></ul><p>Enum values:</p><ul><li><i>0 = List</i></li><li><i>1 = Kanban</i></li></ul>
Pageinteger
ItemsPerPageinteger
ReturnTotalItemsboolean
sortColstring
sortDirstring
Response
OK
Example response
{
"items": [
{
"name": "Acme Inc",
"email": "info@acmeinc.com",
"phone": "12124567890",
"web": "acmeinc.com",
"countryCode": "US"
}
]
}Changes
No recorded changes to this operation across all 3 revisions of this API.