> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fintoc.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List refresh intents

> Returns a paginated list of the refresh intents of a link, most recent first, using the link's `link_token` to authenticate the request.

**`v1`** · Base URL `https://api.fintoc.com/v1`


## OpenAPI

````yaml reference/fintoc-api.json GET /refresh_intents
openapi: 3.1.0
info:
  title: fintoc-api
  version: v2026-02-01
servers:
  - url: https://api.fintoc.com/v1
security: []
paths:
  /refresh_intents:
    get:
      tags:
        - Refresh intents
      summary: List refresh intents
      description: >-
        Returns a paginated list of the refresh intents of a link, most recent
        first, using the link's `link_token` to authenticate the request.
      operationId: refresh-intents-list
      parameters:
        - name: link_token
          in: query
          required: true
          schema:
            type: string
            example: link_Q0xVGPvijElLRMwE_token_FhsFVurz5q5FycHA5xxhTpzX
          description: >-
            The `link_token` of the link that holds the refresh intents to list,
            obtained when you exchanged the link.
        - name: page
          in: query
          required: false
          schema:
            type: integer
            format: int32
          description: Page number to retrieve. Starts at `1`.
        - name: per_page
          in: query
          required: false
          schema:
            type: string
          description: >-
            Number of refresh intents per page. Defaults to `30`. The maximum is
            `300`.
      responses:
        '200':
          description: >-
            Paginated list of refresh intents. The `Link` and `X-Total-Count`
            headers carry the pagination information.
          headers:
            Link:
              schema:
                type: string
            X-Total-Count:
              schema:
                type: integer
          content:
            application/json:
              examples:
                refresh_intents_list:
                  value:
                    - id: ri_2dXqkOKkS9mOvnaW
                      object: refresh_intent
                      created_at: '2021-08-23T18:22:46.792Z'
                      public_error: null
                      refreshed_object: link
                      refreshed_object_id: link_nzwA3XWYiZkg4ojK
                      requires_mfa: null
                      status: succeeded
                      type: only_last
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/refresh_intent'
        '401':
          description: Invalid or missing API key.
          content:
            application/json:
              examples:
                invalid_api_key:
                  value:
                    error:
                      type: authentication_error
                      code: invalid_api_key
                      message: 'Invalid API Key: invalid-*oken'
              schema:
                $ref: '#/components/schemas/error_object'
        '403':
          description: >-
            The `link_token` is invalid or belongs to a different mode than the
            API key.
          content:
            application/json:
              examples:
                invalid_link_token:
                  value:
                    error:
                      type: invalid_request_error
                      code: invalid_link_token
                      param: link_token
                      message: >-
                        Invalid access token for link:
                        link_nMNejK7BT8oGbvO4_token_****
                      doc_url: https://docs.fintoc.com/reference/errors
              schema:
                $ref: '#/components/schemas/error_object'
      security:
        - api_key: []
components:
  schemas:
    refresh_intent:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the refresh intent.
          example: ri_2dXqkOKkS9mOvnaW
        object:
          const: refresh_intent
          description: Type of the object. Always `refresh_intent`.
        created_at:
          type: string
          format: date-time
          description: ISO 8601 timestamp of when the refresh intent was created.
          example: '2021-08-23T18:22:46.792Z'
        new_movements:
          type: integer
          description: >-
            Number of new movements the refresh fetched. Only present when
            `refreshed_object` is `account` (for example, in webhook payloads).
          example: 12
        public_error:
          type:
            - string
            - 'null'
          enum:
            - retryable_error
            - support_required_error
            - null
          description: >-
            Reason for the failure. `retryable_error` means you can retry the
            refresh, `support_required_error` means you need to contact Fintoc
            support. `null` unless `status` is `failed`.
          example: null
        refreshed_object:
          type: string
          enum:
            - link
            - account
          description: >-
            Type of the object being refreshed. The refresh intents API always
            returns `link` refresh intents.
          example: link
        refreshed_object_id:
          type: string
          description: Identifier of the object being refreshed.
          example: link_nzwA3XWYiZkg4ojK
        requires_mfa:
          type:
            - object
            - 'null'
          description: >-
            Present when the institution requires multi-factor authentication to
            complete the refresh; contains the `widget_token` needed to resume
            the flow in the widget. `null` otherwise. Only included when
            `refreshed_object` is `link`.
          properties:
            widget_token:
              type: string
              description: >-
                Token used to initialize the Fintoc widget to complete the
                multi-factor authentication.
              example: ri_2dXqkOKkS9mOvnaW_sec_Q802GD8ZLmMuK0Atl4ucJuLp
        status:
          type: string
          enum:
            - created
            - waiting_for_action
            - requires_action
            - processing_action
            - rejected
            - failed
            - succeeded
            - canceled
          description: >-
            Status of the refresh intent. `rejected` means the institution
            rejected the stored credentials.
          example: succeeded
        type:
          type: string
          enum:
            - only_last
            - historical
          description: >-
            Type of the refresh. `only_last` fetches the most recent movements,
            `historical` fetches the full history of movements.
          example: only_last
      required:
        - id
        - object
        - refreshed_object
        - refreshed_object_id
        - requires_mfa
        - status
        - created_at
        - type
        - public_error
    error_object:
      type: object
      properties:
        error:
          type: object
          description: Details of the error that caused the request to fail.
          properties:
            code:
              type: string
              description: >-
                Machine-readable code identifying the specific error, for
                example `invalid_api_key`. Not returned by every error.
              example: invalid_api_key
            doc_url:
              type: string
              description: >-
                URL of a documentation page with more details about the error.
                Not returned by every error.
              example: https://docs.fintoc.com/reference/errors
            message:
              type: string
              description: Human-readable message describing the error.
              example: 'Invalid API Key: invalid-*oken'
            param:
              type:
                - string
                - 'null'
              description: >-
                Name of the request parameter that caused the error. `null` when
                the error cannot be tied to a single parameter, and not returned
                by every error.
              example: amount
            type:
              type: string
              description: >-
                Category of the error, for example `invalid_request_error`,
                `authentication_error`, or `api_error`.
              example: invalid_request_error
          required:
            - type
            - message
  securitySchemes:
    api_key:
      type: apiKey
      name: Authorization
      in: header

````