> ## 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. # Get Links > List all connected account links. Returns all financial institution and payroll links for the authenticated user. Supports optional filtering by link status and data source type. status reflects the last stable status, so a refresh in flight does not flip a link out of its last committed status; is_refreshing flags links currently refreshing. ## OpenAPI ````yaml GET /v1/links openapi: 3.1.0 info: title: Truv Public API description: > Read-only API for personal access token (PAT) users. ## Authentication Authenticate with `Authorization: Bearer `. Tokens have a `pat_` prefix and are generated in the Truv web app under Settings → API keys. ## Available Endpoints This API exposes a subset of read-only endpoints for retrieving financial data, account links, and user profile information. version: 1.0.0 servers: - url: https://api.mytruv.com description: Production security: - BearerAuth: [] tags: - name: users description: User profile — read-only access to the authenticated user's profile. - name: financial-data description: >- Financial data — balances, transactions, income, spending, liabilities, and balance history. - name: links description: >- Account links — list connected financial institutions and payroll providers. paths: /v1/links: get: tags: - links summary: Get Links description: >- List all connected account links. Returns all financial institution and payroll links for the authenticated user. Supports optional filtering by link status and data source type. status reflects the last stable status, so a refresh in flight does not flip a link out of its last committed status; is_refreshing flags links currently refreshing. operationId: listLinks parameters: - name: statuses in: query required: false schema: anyOf: - items: type: string type: array - type: 'null' description: >- Filter links by status (e.g. 'done', 'new', 'error'). Omit to include all statuses. title: Statuses description: >- Filter links by status (e.g. 'done', 'new', 'error'). Omit to include all statuses. - name: data_sources in: query required: false schema: anyOf: - type: array items: $ref: '#/components/schemas/DataSource2' - type: 'null' description: >- Filter links by data source type (e.g. 'payroll', 'financial_accounts'). Omit to include all. title: Data Sources description: >- Filter links by data source type (e.g. 'payroll', 'financial_accounts'). Omit to include all. responses: '200': description: Paginated list of connected financial institution and payroll links. content: application/json: schema: $ref: '#/components/schemas/LinksListView' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' components: schemas: DataSource2: type: string enum: - payroll - docs - insurance - financial_accounts - tax - scoring_attributes - credit title: DataSource2 description: >- 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. LinksListView: properties: results: items: $ref: '#/components/schemas/LinkView' type: array title: Results description: Connected financial institution and payroll links. count: type: integer title: Count description: Number of links returned. examples: - 2 next: anyOf: - type: string - type: 'null' title: Next description: URL of the next page, if any. previous: anyOf: - type: string - type: 'null' title: Previous description: URL of the previous page, if any. type: object required: - results - count title: LinksListView description: Paginated list of connected links returned by GET /v1/links. HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError LinkView: properties: id: type: string title: Id examples: - 48427a36d43c4d5aa6324bc06c692456 created_at: anyOf: - type: string - type: 'null' title: Created At examples: - '2022-06-07T15:00:00Z' updated_at: anyOf: - type: string - type: 'null' title: Updated At examples: - '2022-06-31T15:00:00Z' deleted_at: anyOf: - type: string - type: 'null' title: Deleted At examples: - '2022-06-31T15:00:00Z' tracking_info: anyOf: - type: string - type: 'null' title: Tracking Info examples: - user123456 status: anyOf: - type: string - type: 'null' title: Status description: >- Last stable link status, a successful `done` or an error. Falls back to the live status only before the link has ever reached a stable status (its first-ever sync). examples: - done user_external_id: anyOf: - type: string - type: 'null' title: User External Id examples: - user123456 provider_id: anyOf: - type: string - type: 'null' title: Provider Id examples: - adp provider: anyOf: - $ref: '#/components/schemas/ProviderBase' - type: 'null' company_mapping: anyOf: - $ref: '#/components/schemas/Employer' - type: 'null' link_hash: anyOf: - type: string - type: 'null' title: Link Hash examples: - bc917458a3da4b2c8cc8282aa1707aaa allowed_products: anyOf: - items: $ref: '#/components/schemas/AllowedProduct2' type: array - type: 'null' title: Allowed Products initial_product_type: anyOf: - $ref: '#/components/schemas/InitialProductType' - type: 'null' examples: - income data_source: anyOf: - $ref: '#/components/schemas/DataSource2' - type: 'null' examples: - payroll is_suspicious: anyOf: - type: boolean - type: 'null' title: Is Suspicious is_dds_available: anyOf: - type: boolean - type: 'null' title: Is Dds Available is_refreshing: type: boolean title: Is Refreshing description: >- True while a data refresh is in flight (the link's live status is one of login/parse/full_parse/mfa). `status` keeps reporting the last stable status during this window. default: false additionalProperties: true type: object required: - id title: LinkView description: >- A connected link as exposed by GET /v1/links. status reports the last stable status, so a refresh in flight never flips the link out of its last committed status; is_refreshing reports that a refresh is underway, so clients can show a non-blocking indicator instead of hiding data. ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError ProviderBase: properties: id: type: string maxLength: 64 title: Id examples: - adp name: type: string maxLength: 128 title: Name examples: - ADP logo_url: anyOf: - type: string - type: 'null' title: Logo Url additionalProperties: true type: object required: - id - name title: ProviderBase Employer: properties: id: type: string maxLength: 64 title: Id examples: - meta name: type: string maxLength: 128 title: Name examples: - Meta logo_url: anyOf: - type: string - type: 'null' title: Logo Url additionalProperties: true type: object required: - id - name title: Employer AllowedProduct2: type: string enum: - income - employment - deposit_switch - pll - insurance - transactions - assets - admin - credit title: AllowedProduct2 InitialProductType: type: string enum: - income - employment - deposit_switch - pll - insurance - transactions - assets - admin - credit title: InitialProductType description: Initial product type securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: PAT description: >- Bearer authentication with a personal access token (prefix `pat_`). Generate tokens in the Truv web app under Settings → API keys. ````