Retrieve an Item filter
curl --request GET \
--url https://api-sandbox.argyle.com/v2/item-filters/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api-sandbox.argyle.com/v2/item-filters/{id}"
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/{id}', 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/{id}",
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/{id}"
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/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.argyle.com/v2/item-filters/{id}")
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{
"id": "087394d4-83b5-4722-8c5e-0235362c12f5",
"name": "Key paystub fields supported",
"filters": {
"status": {
"eq": "healthy"
},
"field_coverage": {
"paystubs": {
"gross_pay": {
"supported": {
"eq": true
}
},
"paystub_date": {
"supported": {
"eq": true
}
}
}
}
}
}Item Filters
Retrieve An Item Filter
Retrieves an Item filter.
GET
/
v2
/
item-filters
/
{id}
Retrieve an Item filter
curl --request GET \
--url https://api-sandbox.argyle.com/v2/item-filters/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api-sandbox.argyle.com/v2/item-filters/{id}"
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/{id}', 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/{id}",
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/{id}"
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/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.argyle.com/v2/item-filters/{id}")
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{
"id": "087394d4-83b5-4722-8c5e-0235362c12f5",
"name": "Key paystub fields supported",
"filters": {
"status": {
"eq": "healthy"
},
"field_coverage": {
"paystubs": {
"gross_pay": {
"supported": {
"eq": true
}
},
"paystub_date": {
"supported": {
"eq": true
}
}
}
}
}
}Authorizations
Username = api_key_id, Password = api_key_secret
Path Parameters
ID of the Item filter to be retrieved.
Response
200 - application/json
The ID of the item filter.
Example:
"087394d4-83b5-4722-8c5e-0235362c12f5"
The name of the item filter.
Example:
"Key paystub fields supported"
The filters applied to this item filter.
Example:
{
"status": { "eq": "healthy" },
"field_coverage": {
"paystubs": {
"gross_pay": { "supported": { "eq": true } },
"paystub_date": { "supported": { "eq": true } }
}
}
}
⌘I