Item Filters
Create custom filters that can be used as a search parameter when listing Items.
#Create an Item filter
post/v2/item-filters
Filters are applied to properties of the field_coverage object and direct_deposit_switch 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
Request body
- #namestringrequired
Name for the Item filter.
- #filtersobjectoptional
The set of filters, which can be applied when listing Items.
Example Request
1curl --request POST \
2 --url https://api.argyle.com/v2/item-filters \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json' \
5 --data '{
6 "name": "Allocation data fields available and deposit switches supported",
7 "filters": {
8 "status": { "eq": "healthy" },
9 "field_coverage": {
10 "deposit_destinations": {
11 "ach_deposit_account": {
12 "routing_number": { "supported": { "eq": true } },
13 "account_number": { "supported": { "eq": true } },
14 "account_type": { "supported": { "eq": true } }
15 },
16 "status": { "supported": { "eq": true } },
17 "allocation_type": { "supported": { "eq": true } }
18 }
19 },
20 "direct_deposit_switch": {
21 "deposit_account": {
22 "supported": { "eq": true },
23 "max_allocations": { "gte": "1" },
24 "amount_allocation": { "eq": true },
25 "percent_allocation": { "eq": true }
26 }
27 }
28 }
29 }'Example Response
1{
2 "id": "087394d4-83b5-4722-8c5e-0235362c12f5",
3 "name": "Allocation data fields available and deposit switches supported"
4}#Retrieve an Item filter
get/v2/item-filters/{id}
Retrieves an Item filter.
Path parameters
- #idstring (uuid)required
ID of the Item filter to be retrieved.
Example Request
1curl --request GET \
2 --url https://api.argyle.com/v2/item-filters/{id} \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json'Example Response
1{
2 "id": "087394d4-83b5-4722-8c5e-0235362c12f5",
3 "name": "Allocation data fields available and deposit switches supported",
4 "filters": {
5 "status": {
6 "eq": "healthy"
7 },
8 "field_coverage": {
9 "deposit_destinations": {
10 "ach_deposit_account": {
11 "routing_number": {
12 "supported": {
13 "eq": true
14 }
15 },
16 "account_number": {
17 "supported": {
18 "eq": true
19 }
20 },
21 "account_type": {
22 "supported": {
23 "eq": true
24 }
25 }
26 },
27 "status": {
28 "supported": {
29 "eq": true
30 }
31 },
32 "allocation_type": {
33 "supported": {
34 "eq": true
35 }
36 }
37 }
38 },
39 "direct_deposit_switch": {
40 "deposit_account": {
41 "supported": {
42 "eq": true
43 },
44 "max_allocations": {
45 "gte": "1"
46 },
47 "amount_allocation": {
48 "eq": true
49 },
50 "percent_allocation": {
51 "eq": true
52 }
53 }
54 }
55 }
56}#Replace an Item filter
put/v2/item-filters/{id}
Replaces the filters of an Item filter with a new set of filters.
Path parameters
- #idstring (uuid)required
ID of the Item filter whose filters are to be replaced.
Example Request
1curl --request PUT \
2 --url https://api.argyle.com/v2/item-filters/{id} \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json'
5 --data '{
6 "name": "Multiple allocations for deposit switches",
7 "filters": {
8 "direct_deposit_switch": {
9 "deposit_account": {
10 "supported": { "eq": true },
11 "max_allocations": { "gte": "2"},
12 "amount_allocation": { "eq": true },
13 "percent_allocation": { "eq": true }
14 }
15 }
16 }
17 }'Example Response
1{
2 "id": "087394d4-83b5-4722-8c5e-0235362c12f5",
3 "name": "Multiple allocations for deposit switches"
4}#Delete an Item filter
delete/v2/item-filters/{id}
Deletes an Item filter.
Path parameters
- #idstring (uuid)required
ID of the Item filter to be deleted.
Example Request
1curl --request DELETE \
2 --url https://api.argyle.com/v2/item-filters/{id} \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json'Example Response
1"204 status code: No content."#List all Item filters
get/v2/item-filters
Returns an array of all Item filters.
Example Request
1curl --request GET \
2 --url https://api.argyle.com/v2/item-filters?limit=2 \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json'Example Response
1[
2 {
3 "name": "Candidate for new car loan fields supported",
4 "filters": {
5 "field_coverage": {
6 "gigs": {
7 "distance": {
8 "supported": true
9 }
10 },
11 "vehicles": {
12 "year": {
13 "supported": true
14 }
15 }
16 }
17 }
18 },
19 {
20 "name": "Deposit switching supported",
21 "filters": {
22 "direct_deposit_switch": {
23 "deposit_account": {
24 "supported": {
25 "eq": true
26 }
27 }
28 }
29 }
30 }
31]