HEherondata
Integrations

Get IntegrationLinks by Integration

Get a list of IntegrationLinks for an Integration filtered by end user

get/api/integrations/{heron_id}/links

Request

  • Base URL
    https://app.herondata.io
  • URL
    https://app.herondata.io/api/integrations/{heron_id}/links
  • Auth
    API key in header x-api-key

Path parameters

heron_idstring required

The Integration's heron_id

Query parameters

end_user_id_or_heron_idstring required

Return only IntegrationLinks for that end user

Response

OK

Example response

{
  "links": [
    {
      "access_token": "access-sandbox-de3ce8ef-33f8-452c-a685-8671031fc0f6",
      "created": "2020-01-01T00:00:00Z",
      "end_user_id": "bf9c3153-e876-4386-bc03-4429a7275f26",
      "end_user_name": "Acme Corp",
      "item_id": "M5eVJqLnv3tbzdngLDp9FL5OlDNxlNhlE55op",
      "last_successful_sync": "2020-01-01T00:00:00Z",
      "last_updated": "2020-01-01T00:00:00Z",
      "status": "active",
      "status_message": "[ITEM_LOGIN_REQUIRED] the login details of this item have changed (credentials, MFA, or required user action) and a user login is required to update this information. use Link's update mode to restore the item to a good state",
      "type": "plaid_assets_report"
    }
  ]
}

Changes

No recorded changes to this operation across all 3 revisions of this API.