Skip to main content
GET
/
v1
/
tasks
List all tasks
curl --request GET \
  --url https://prod.truv.com/v1/tasks/ \
  --header 'X-Access-Client-Id: <api-key>' \
  --header 'X-Access-Secret: <api-key>'
{
  "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",
      "link_id": "48427a36d43c4d5aa6324bc06c692456",
      "user_id": "48427a36d43c4d5aa6324bc06c692456",
      "error_message": "Invalid credentials provided",
      "tracking_info": "0c8d444ff53947cd822efca7b3d9ef18",
      "bridge_token": "2f67984a110747d190c39e1022c81837",
      "data_source": "financial_accounts",
      "is_suspicious": false,
      "order_id": "48427a36d43c4d5aa6324bc06c692456"
    }
  ],
  "next": "<string>",
  "previous": "<string>"
}

Authorizations

​
X-Access-Client-Id
string
header
required

Client ID

​
X-Access-Secret
string
header
required

Client Access Key

Query Parameters

​
ordering
enum<string>

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

Available options:
created_at,
-created_at,
updated_at,
-updated_at,
status,
-status,
error_message,
-error_message,
provider_id,
-provider_id
​
created_at__lte
string<date-time>

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

​
created_at__gte
string<date-time>

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

​
status
enum<string>

Filter by task status code.

Available options:
done,
error,
login_error,
account_locked,
mfa_error,
config_error,
no_data,
unavailable,
unable_to_reset,
not_supported
​
query
string

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

​
provider
string

Filter by provider id.

​
product_type
enum<string>

Filter by product type.

Available options:
income,
employment,
deposit_switch,
pll,
insurance,
transactions,
assets
​
user_id
string

Filter by user id.

​
cursor
string

The pagination cursor value.

​
page_size
integer

Number of results to return per page.

Response

​
results
object[]
required
​
next
string<uri> | null
​
previous
string<uri> | null