Sign in

v4

OpenAPI 3.0.12026-07-3189233676.2 KB
Tasks

List all tasks

The endpoint returns a list of Tasks.

get/v1/tasks/

Query parameters

ordering'created_at' | '-created_at' | 'updated_at' | '-updated_at' | 'status' | '-status' | 'error_message' | '-error_message' | 'provider_id' | '-provider_id'
Example:created_at

Which field to use when ordering the results. The default is by descending created_at.

created_at__ltestring date-time

Filter created_at less than or equal (ISO-8601).

created_at__gtestring date-time

Filter created_at greater than or equal (ISO-8601).

status'done' | 'error' | 'login_error' | 'account_locked' | 'mfa_error' | 'config_error' | 'no_data' | 'unavailable' | 'unable_to_reset' | 'not_supported'
Example:done

Filter by task status code.

querystring

Search query by the following fields: id, link id, bridge token, order group id, tracking info.

providerstring

Filter by provider id.

product_type'income' | 'employment' | 'deposit_switch' | 'pll' | 'insurance' | 'transactions' | 'assets'
Example:income

Filter by product type.

user_idstring

Filter by user id.

cursorstring

The pagination cursor value.

page_sizeinteger

Number of results to return per page.

Response

nextstring uri nullable
previousstring uri nullable

Example response

{
  "results": [
    {
      "id": "48427a36d43c4d5aa6324bc06c692456",
      "status": "done",
      "product_type": "income",
      "provider": {
        "id": "adp",
        "name": "ADP",
        "logo_url": "https://cdn.truv.com/providers/adp.svg"
      },
      "created_at": "2022-06-07T15:00:00Z",
      "updated_at": "2022-06-07T15:30:00Z",
      "error_message": "Invalid credentials provided",
      "tracking_info": "0c8d444ff53947cd822efca7b3d9ef18",
      "bridge_token": "2f67984a110747d190c39e1022c81837",
      "data_source": "financial_accounts",
      "link_id": "48427a36d43c4d5aa6324bc06c692456",
      "user_id": "48427a36d43c4d5aa6324bc06c692456",
      "order_id": "48427a36d43c4d5aa6324bc06c692456"
    }
  ]
}