---
title: "List links"
method: GET
path: "/links"
tags: ["Links"]
---

# List links

`GET /links`

List links from data sources.

## Query parameters

- `size` integer
- `cursor` string
- `userId` string
- `sourceId` string

## Response `200`

List Links Response

- LinkListResponse
  - `code` 'OK' | 'CREATED' | 'INVALID_CREDENTIALS' | 'INVALID_PARAMETERS' | 'INVALID_TOKEN' | 'UNAUTHORIZED_ACCESS' | 'MISSING_RESOURCE' | 'REQUEST_LIMIT_EXCEEDED' | 'SERVER_ERROR' | 'UNSUPPORTED_METHOD' | 'SERVER_UNAVAILABLE' | 'TIME_LIMIT_EXCEEDED', required — Request status code
  - `message` string — Message response to the request
  - `requestId` string, required — Unique ID that is added to the body of every response for easy traceability of the request in our logs.
  - `data` LinkListData
    - `nextCursor` string — The next cursor value that can be used in the following query.
    - `items` Link[]
      - `id` string, required — Link request ID
      - `startDate` string, date-time — Date and time
      - `endDate` string, date-time, required — Date and time
      - `records` object[] — Link records
        - `count` integer, required — The number of times the user has linked at least one account with other participating organizations
        - `linkedAt` RefDateTime[] — The latest link time of each application
      - `metadata` ObjectReferenceMetadata, required — Metadata related to account-specific data
        - `itemCreatedAt` string, date-time, required — Date and time
        - `createdAt` string, date-time, required — Date and time
        - `accountId` string — The accountId of this object
        - `sourceId` string, required — The ACCOUNT or ARCHIVE ID associated with this object
        - `sourceType` 'ACCOUNT' | 'UPLOAD' | 'ARCHIVE' | 'SOCIAL_SECURITY', nullable, required — Source Type
        - `userId` string, required — The user ID associated with this object
        - `providerId` string, required — The provider ID associated with this object

---

[API](https://skmtc.dev/smileapi/apis/smile-api.md) · [All operations](https://skmtc.dev/smileapi/apis/smile-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/smileapi/smile-api/revisions/a4930eb49f4d/schema)
