v4

OpenAPI 3.0.12026-07-3189233676.2 KB

Account Links

List all links

get/v1/links/

Query parameters

user_idstring

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

Response

countinteger required

Number of Links to return

nextstring nullable required

Url to the next page

previousstring nullable required

Url to the previous page

Example response

{
  "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:00Z",
      "updated_at": "2022-06-30T15:00:00Z",
      "deleted_at": "2022-06-30T15:00:00Z",
      "tracking_info": "user123456",
      "status": "new",
      "user_external_id": "user123456",
      "provider_id": "adp",
      "provider": {
        "id": "adp",
        "name": "ADP"
      },
      "company_mapping": {
        "id": "meta",
        "name": "Meta"
      },
      "link_hash": "bc917458a3da4b2c8cc8282aa1707aaa",
      "allowed_products": [
        "income"
      ],
      "initial_product_type": "income",
      "data_source": "payroll"
    }
  ]
}