Skip to main content
GET
/
v1
/
links
Get Links
curl --request GET \
  --url https://api.mytruv.com/v1/links \
  --header 'Authorization: Bearer <token>'
{
  "count": "100",
  "results": [
    {
      "id": "48427a36d43c4d5aa6324bc06c692456",
      "created_at": "2022-06-07T15:00:00Z",
      "updated_at": "2022-06-31T15:00:00Z",
      "deleted_at": "2022-06-31T15:00:00Z",
      "tracking_info": "user123456",
      "status": "new",
      "user_external_id": "user123456",
      "provider_id": "adp",
      "provider": {
        "id": "adp",
        "name": "ADP",
        "logo_url": "<string>"
      },
      "company_mapping": {
        "id": "meta",
        "name": "Meta",
        "logo_url": "<string>"
      },
      "link_hash": "bc917458a3da4b2c8cc8282aa1707aaa",
      "allowed_products": [],
      "initial_product_type": "income",
      "data_source": "payroll",
      "is_suspicious": true,
      "is_dds_available": true
    }
  ],
  "next": "https://api.mytruv.com/v1/links?page=1",
  "previous": "https://api.mytruv.com/v1/links?page=1"
}

Documentation Index

Fetch the complete documentation index at: https://help.mytruv.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication with a personal access token (prefix pat_). Generate tokens in the MyTruv web app under Settings > Sharing.

Query Parameters

​
statuses
string[] | null
​
data_sources
enum<string>[] | null

Source of data: payroll - payroll provider parsing, docs - user uploaded documents, insurance - insurance data, financial_accounts - bank data, tax - tax documents, scoring_attributes - transactions scoring attributes report.

Available options:
payroll,
docs,
insurance,
financial_accounts,
tax,
scoring_attributes

Response

Successful Response

List all links

​
count
integer
required
Example:

"100"

​
results
Link · object[]
required
​
next
string | null
Example:

"https://api.mytruv.com/v1/links?page=1"

​
previous
string | null
Example:

"https://api.mytruv.com/v1/links?page=1"