Retrieve a data refresh status

The endpoint returns the refresh task status.

get/v1/refresh/tasks/{task_id}/

Response

idstring required

Unique refresh task ID

created_atstring

Time when refresh task was created

refresh_datestring date required

Date of the data refresh (Deprecated, invalid datetime format)

Refresh task status. Includes in-progress statuses (new, login, mfa, parse, full_parse, switch_deposit, session_expired) that appear while the refresh is still running, and the terminal statuses shared with tasks.

Example response

{
  "id": "24d7e80942ce4ad58a93f70ce4115f5c",
  "created_at": "2021-04-06T11:30:00Z",
  "refresh_date": "2020-03-10",
  "status": "new"
}

Changes

Changed in 1 of the 11 revisions of this API.17

Jul 27, 2026f7c01387551617See the full diff
- ●
  added the new account_locked enum value to the status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new config_error enum value to the status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new done enum value to the status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new error enum value to the status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new full_parse enum value to the status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new login enum value to the status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new login_error enum value to the status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new mfa enum value to the status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new mfa_error enum value to the status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new new enum value to the status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new no_data enum value to the status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new not_supported enum value to the status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new parse enum value to the status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new session_expired enum value to the status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new switch_deposit enum value to the status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new unable_to_reset enum value to the status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new unavailable enum value to the status response property for the response status 200
  response-property-enum-value-added

Full history