Legacy Docs

Item Notifications

View changes in Item health and availability.

The Item notifications endpoint provides a searchable, public timeline of:

  • When new or previously removed Items are now available and support payroll connections in Link.
  • When there is a change in an Item's health status or related messaging, including when connection issues occurred.
  • When an existing Item is removed from Link (uncommon).

#The Item notifications object

Attributes
  • idstring (uuid)

    Unique ID of the Item notification.

  • created_atstring (datetime)

    Timestamp (ISO 8601) when the Item notification was created.

  • actionstring (enum)

    Item notification event.

  • messagestring

    Additional messaging related to the event.

  • itemobject

    Object containing Item and event information.

  • idstring (uuid)

    ID of the Item related to the Item notification.

  • namestring

    Name of the Item.

  • statusstring (enum)

    Health status of the Item.

  • status_detailsstring

    Details the impact of status issues, such as degraded account connection ability or paused data updates. Otherwise null.

  • known_limitationsstring

    Details any known limitations for the Item, such as historical data limits or unique behavior. Otherwise null.

  • logo_urlstring

    URL location of the Item's logo image file.

Example
1{
2  "id": "47b216e2-d334-4235-bc1e-185d15ab18d0",
3  "created_at": "2023-01-30T23:39:34.962Z",
4  "action": "updated",
5  "message": "Whole Goods is performing maintenance. Expected downtime: 4 hours.",
6  "item": {
7    "id": "item_123456789",
8    "name": "Whole Goods",
9    "status": "unavailable",
10    "status_details": "New connections and data updates paused.",
11    "known_limitations": "Last 2 digits of SSN are available. The rest are obfuscated.",
12    "logo_url": "https://..."
13  }
14}

#List all Item notifications

get/v2/item-notifications

Returns an array of all Item notifications.

Query parameters
  • limitinteger
    optional

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

  • itemstring
    optional

    Filter Item notifications by Item ID.

  • actionstring (enum)
    optional

    Filter by action.

  • statusstring (enum)
    optional

    Filter by status.

  • kindstring (enum)
    optional

    Filter for Item's with a specific kind value (see Items).

  • from_created_atstring (datetime)
    optional

    Filter for Item notifications created on or after this timestamp. Format is ISO 8601.

  • to_created_atstring (datetime)
    optional

    Filter for Item notifications created on or before this timestamp. Format is ISO 8601.

Example Request
1curl --request GET \
2     --url https://api.argyle.com/v2/item-notifications?limit=3 \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'
Example Response
1[
2  {
3    "id": "47b216e2-d334-4235-bc1e-185d15ab18d0",
4    "created_at": "2023-01-31T03:23:45.827Z",
5    "action": "updated",
6    "message": "Whole Goods maintenance still in progress. Expected completion in 2 hours.",
7    "item": {
8      "id": "item_123456789",
9      "name": "Whole Goods",
10      "status": "unavailable",
11      "status_details": null,
12      "known_limitations": "Last 2 digits of SSN are available. The rest are obfuscated.",
13      "logo_url": "https://..."
14    }
15  },
16  {
17    "id": "47b216e2-d334-4235-bc1e-185d15ab18d0",
18    "created_at": "2023-01-31T05:13:54.372Z",
19    "action": "created",
20    "message": "Service to Whole Goods has been restored.",
21    "item": {
22      "id": "item_123456789",
23      "name": "Whole Goods",
24      "status": "healthy",
25      "status_details": null,
26      "known_limitations": "Last 2 digits of SSN are available. The rest are obfuscated.",
27      "logo_url": "https://..."
28    }
29  },
30  {
31    "id": "e2b5bf05-d84b-44c3-b48e-2c0beec83bdf",
32    "created_at": "2023-01-31T12:39:34.962Z",
33    "action": "updated",
34    "message": "Intermittent connection issues fully resolved.",
35    "item": {
36      "id": "item_000000001",
37      "name": "Half Bads",
38      "status": "healthy",
39      "status_details": null,
40      "known_limitations": null,
41      "logo_url": "https://..."
42    }
43  }
44]