---
title: "Filter companies"
method: POST
path: "/companies/search"
tags: ["Companies"]
---

# Filter companies

`POST /companies/search`

This section describes the filters and fields that can be used to filter search results for this endpoint. The example
given is the most simple way to pass a filter into the call. For a more in-depth explanation of boolean filtering,
consult the section near the top of this page dealing with filtering.

The following are all the Company fields that can currently be filtered on, and which filters can be used on each:

```markdown
`id` - greater_than, less_than, between, exactly, is_empty
`owner_id` - greater_than, less_than, between, exactly, is_empty
`name` - contains, exactly, is_empty
`website` - contains, exactly, is_empty
`address.street` - contains, exactly, is_empty
`address.city` - contains, exactly, is_empty
`address.state` - contains, exactly, is_empty
`address.postal_code` - geo_distance, contains, exactly, is_empty
`country_code` - contains, exactly, is_empty
`phones.primary` - contains, exactly, is_empty
`phones.secondary` - contains, exactly, is_empty
`phones.fax` - contains, exactly, is_empty
`entered_by_id` - greater_than, less_than, between, exactly, is_empty
`notes` - contains, exactly, is_empty
`is_hot` - exactly, is_empty
`key_technologies` - contains, exactly, is_empty
`billing_contact_id` - greater_than, less_than, between, exactly, is_empty
`status_id` - greater_than, less_than, between, exactly, is_empty
`date_created` - greater_than, less_than, between, is_empty
`date_modified` - greater_than, less_than, between, is_empty

```

## Query parameters

- `query` string, required
- `page` number, required
- `per_page` number, required

## Request body

- object
  - `field` string, required — The field to filter on. See the above list to determine which fields can be filtered.
  - `filter` string, required — The filter to use. See the above list to determine which fields allow what filters.
  - `value` string, required — The value to filter by. Different filters take different value types (string, array, int). See the section in the introduction to see what values each filter accepts.

## Response `200`

OK

- object
  - `count` number
  - `total` number
  - `_links` object
  - `_embedded` object
    - `companies` unknown[]
      - unknown

---

[API](https://skmtc.net/catsone/apis/cats-api-v3.md) · [All operations](https://skmtc.net/catsone/apis/cats-api-v3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/catsone/cats-api-v3/versions/dedbbade450d/schema)