Skip to main content
POST
Create an Item filter
Filters are applied to properties of the field_coverage object of Items using the comparison operators below. You can also filter Items by their status property using the eq operator. The name and ID of the new Item filter are returned in the response, which can be used as a query parameter when listing Items.

Comparison operators

  • eq — equals
  • gt — greater than
  • gte — greater than or equal to
  • lt — less than
  • lte — less than or equal to

Authorizations

Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Body

application/json
name
string
required

Name for the Item filter.

filters
object

The set of filters, which can be applied when listing Items.

Response

200 - application/json
id
string

The ID of the item filter.

Example:

"087394d4-83b5-4722-8c5e-0235362c12f5"

name
string

The name of the item filter.

Example:

"Key paystub fields supported"