Filters

The entity type of the filter determines which fields are available in conditions. The field type determines which operators are available. Here's a reference for the compatible fields and operators along with some usage examples.

• Field reference
• Operator reference
• Usage examples

Field reference

Party filters

Opportunity filters

Project filters

Operator reference

Usage examples

Basic example

To find all parties tagged with example:

{
  "filter": {
    "conditions": [
      {
        "field": "tag",
        "operator": "is",
        "value": "example"
      }
    ]
  }
}

Querying by ID

Tags can also be referenced by ID. This is useful because it ensures that conditions will continue to work even if the tag is renamed:

{
  "filter": {
    "conditions": [
      {
        "field": "tag",
        "operator": "is",
        "value": 123
      }
    ]
  }
}

Multiple search conditions

To find all people in the United States that were added in 2018:

{
  "filter": {
    "conditions": [
      {
        "field": "type",
        "operator": "is",
        "value": "person"
      },
      {
        "field": "country",
        "operator": "is",
        "value": "US"
      },
      {
        "field": "addedOn",
        "operator": "is after",
        "value": "2017-12-31"
      },
      {
        "field": "addedOn",
        "operator": "is before",
        "value": "2019-01-01"
      }
    ]
  }
}

Using a nested condition group

To find opportunities owned by user 123 or user 456:

{
  "filter": {
    "conditions": [
      {
        "orGroup": [
          {
            "field": "owner",
            "operator": "is",
            "value": 123
          },
          {
            "field": "owner",
            "operator": "is",
            "value": 456
          }
        ]
      }
    ]
  }
}

Specifying results order

To find all people sorted by last contact date:

{
  "filter": {
    "conditions": [
      {
        "field": "type",
        "operator": "is",
        "value": "person"
      }
    ],
    "orderBy": [
      {
        "field": "lastContactedOn",
        "direction": "ascending"
      }
    ]
  }
}

Filtering by custom field value

When filtering by custom field, it should be referenced by its ID. To find all parties with a value of true in a custom field with an ID of 1:

{
  "filter": {
    "conditions": [
      {
        "field": "custom:1",
        "operator": "is",
        "value": true
      }
    ]
  }
}