---
title: "Performs a text search on companies and returns the matching results"
method: GET
path: "/v1/companies/search"
tags: ["Company"]
---

# Performs a text search on companies and returns the matching results

`GET /v1/companies/search`

## Request

- Base URL: `https://api.infoset.app` (the document declares no server; this is the origin it was published from)
- URL: `https://api.infoset.app/v1/companies/search`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-Api-Key`
- TypeScript: <https://skmtc.dev/infoset/apis/infoset-rest-api/docs/v1/companies/search/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `Query` string, required
- `Fields` string
- `SearchInActivities` boolean
- `SearchType` 0 | 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>
- `Fuzziness` 0 | 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>
- `ViewType` 0 | 1: <p>Enum values:</p><ul><li><i>0 = List</i></li><li><i>1 = Kanban</i></li></ul>
- `Page` integer
- `ItemsPerPage` integer
- `ReturnTotalItems` boolean
- `sortCol` string
- `sortDir` string

## Response `200`

OK

- CompanyResponseModelQueryResult
  - `totalItems` integer
  - `items` CompanyResponseModel[], nullable
    - `contactCount` integer
    - `id` integer
    - `departmentId` integer
    - `name` string, required
    - `code` string, nullable
    - `email` string, nullable
    - `phone` string, nullable: Phone number of the company, with country code, without leading + (plus) sign
    - `web` string, nullable: Website domain of the company
    - `countryCode` string, nullable: ISO Alpha-2 country code, see <a href="https://www.iban.com/country-codes">https://www.iban.com/country-codes</a>
    - `state` string, nullable
    - `city` string, nullable
    - `town` string, nullable
    - `zip` string, nullable
    - `address` string, nullable
    - `createdUserId` integer
    - `createdDate` string, date-time, nullable
    - `updatedUserId` integer
    - `updatedDate` string, date-time, nullable
    - `customFields` string, nullable: A stringified JSON object mapping custom field names to values Example: {"My Text Custom Field":"Field Value","My Numeric Custom Field":2}
    - `photoUrl` string, nullable: Company logo URL

---

[API](https://skmtc.dev/infoset/apis/infoset-rest-api.md) - [All operations](https://skmtc.dev/infoset/apis/infoset-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/infoset/apis/infoset-rest-api/revisions/709c8123f593?raw)