Skip to main content
GET
/
v2
/
items
List all Items
curl --request GET \
  --url https://api-sandbox.argyle.com/v2/items \
  --header 'Authorization: Basic <encoded-value>'
{
  "next": "https://api-sandbox.argyle.com/v2/items?cursor=ZXhhbXBsZV9jdXJzb3I",
  "previous": null,
  "results": [
    {
      "id": "item_000000002",
      "name": "Bullseye",
      "kind": "employer",
      "known_limitations": null,
      "status": "unavailable",
      "status_details": "The Item is down due to scheduled maintenance but should be back shortly.",
      "mapping_status": "verified",
      "logo_url": "argyle.com/image-holdings",
      "is_grouping": false,
      "matching_score": "1.00"
    },
    {
      "id": "item_000000003",
      "name": "Triple",
      "kind": "platform",
      "known_limitations": null,
      "status": "healthy",
      "status_details": null,
      "mapping_status": "mapped",
      "logo_url": "argyle.com/image-holdings",
      "is_grouping": false,
      "matching_score": "0.63"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Query Parameters

​
q
string

Free-text search filter. For best results, use the payroll platform or employer's full name.

​
id
string

Filter by Item ID. Multiple Item IDs can also be searched at once using either method:

  1. /v2/items?id=item_000000001,item_000000002
  2. /v2/items?id=item_000000001&id=item_000000002
​
kind
string

Filter by kind value.

​
status
string

Filter by status value.

Multiple status values can also be searched at once using either method:

  1. /v2/items?status=healthy,issues
  2. /v2/items?status=healthy&status=issues

Filtering by both healthy and issues will return all Items that currently support new payroll connections.

​
mapping_status
string

Filter by mapping_status value.

Multiple mapping_status values can also be searched at once using either method:

  1. /v2/items?mapping_status=verified,mapped
  2. /v2/items?mapping_status=verified&mapping_status=mapped
​
min_matching_score
number

Only returns items with a matching_score greater than or equal to this value. min_matching_score should be used together with the q "free-text search" query parameter.

​
filter_set
string<uuid>

Filter by Item filter ID.

​
limit
integer

Number of Item objects 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
​
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.