<aside> 🔒

Information Classification: Public

</aside>

This document outlines all of the current filters and formatting to use when querying record via the Beacon API.

Contents:

Endpoint

All record types have a filter endpoint available that operates very similarly to the list endpoint, but instead returns a subset of results according to the filters you choose.

POST [<https://api.beaconcrm.org/v1/account/{account_id}/entities/{entity}/filter>](<https://api.beaconcrm.org/v1/account/20116/entities/person/filter>)

All filters that you could use in the Beacon platform are available via the API, and you can even copy the code for an API call directly from the filter drawer in the platform.

Basic format

{
  "filter_conditions": [
    {
      "field": "field_name",
      "operator": "operator",
      "value": "value",
    }
  ],
  "filter_strictness": "all"
}

Easy filter code

<aside> 💡 Tip: To easily get the code for a filter, you can run the filter in Beacon and copy the code from the filter drawer.

1. Go to a list page
2. Add your filter
3. Click on the </> button
4. Paste into your API call!

</aside>

Field types

Short text / Email / Phone number / URL

is

"operator": "==",
"value": "abc"