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>'
import requests

url = "https://api-sandbox.argyle.com/v2/item-filters"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api-sandbox.argyle.com/v2/item-filters', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.argyle.com/v2/item-filters",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api-sandbox.argyle.com/v2/item-filters"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Basic <encoded-value>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api-sandbox.argyle.com/v2/item-filters")
.header("Authorization", "Basic <encoded-value>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.argyle.com/v2/item-filters")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body
{
  "next": "<string>",
  "previous": "<string>",
  "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
              }
            }
          }
        }
      }
    }
  ]
}

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
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.

results
object[]
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 } }
}
}
}
}
]