Skip to main content
GET
/
v2
/
item-filters
List all Item filters
curl --request GET \
  --url https://api-sandbox.argyle.com/v2/item-filters \
  --header 'Authorization: Basic <encoded-value>'
{
  "results": [
    {
      "name": "Candidate for new car loan fields supported",
      "filters": {
        "field_coverage": {
          "gigs": {
            "distance": {
              "supported": true
            }
          },
          "vehicles": {
            "year": {
              "supported": true
            }
          }
        }
      }
    },
    {
      "name": "Key paystub fields supported",
      "filters": {
        "status": {
          "eq": "healthy"
        },
        "field_coverage": {
          "paystubs": {
            "gross_pay": {
              "supported": {
                "eq": true
              }
            },
            "paystub_date": {
              "supported": {
                "eq": true
              }
            }
          }
        }
      }
    }
  ],
  "next": "<string>",
  "previous": "<string>"
}

Authorizations

​
Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Query Parameters

​
limit
integer

Number of Item filters returned per page. Default: 10. Maximum: 200.

​
cursor
string

The URL returned in next or previous used to retrieve another page of results.

Response

200 - application/json
​
results
object[]
required
Example:
[
  {
    "name": "Candidate for new car loan fields supported",
    "filters": {
      "field_coverage": {
        "gigs": { "distance": { "supported": true } },
        "vehicles": { "year": { "supported": true } }
      }
    }
  },
  {
    "name": "Key paystub fields supported",
    "filters": {
      "status": { "eq": "healthy" },
      "field_coverage": {
        "paystubs": {
          "gross_pay": { "supported": { "eq": true } },
          "paystub_date": { "supported": { "eq": true } }
        }
      }
    }
  }
]
​
next
string<uri> | null

URL for the next page of results, if available.

​
previous
string<uri> | null

URL for the previous page of results, if available.