Skip to main content
GET
/
v1
/
links
List all links
curl --request GET \
  --url https://prod.truv.com/v1/links/ \
  --header 'X-Access-Client-Id: <api-key>' \
  --header 'X-Access-Secret: <api-key>'
{
  "count": 100,
  "next": "https://prod.truv.com/v1/links?page=1",
  "previous": "https://prod.truv.com/v1/links?page=1",
  "results": [
    {
      "id": "48427a36d43c4d5aa6324bc06c692456",
      "access_token": "****************************7610",
      "created_at": "2022-06-07T15:00:00.000Z",
      "updated_at": "2022-06-30T15:00:00.000Z",
      "deleted_at": "2022-06-30T15:00:00.000Z",
      "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": [
        "income"
      ],
      "initial_product_type": "income",
      "data_source": "payroll",
      "is_suspicious": true,
      "is_dds_available": true
    }
  ]
}

Authorizations

X-Access-Client-Id
string
header
required

Client ID

X-Access-Secret
string
header
required

Client Access Key

Query Parameters

user_id
string
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Response

List all links

count
integer
required

Number of Links to return

Example:

100

next
string | null
required

Url to the next page

Example:

"https://prod.truv.com/v1/links?page=1"

previous
string | null
required

Url to the previous page

Example:

"https://prod.truv.com/v1/links?page=1"

results
object[]
required

List all links