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

# List website link suggestions

> One run's suggestions (the latest run's unless `run` names another), optionally of one status: `open`, `done` (the seller's mark, which survives runs) or `applied` (a run found the link on the page).



## OpenAPI

````yaml https://api.zeroclick.io/openapi.json get /v1/sellers/{sellerId}/links/suggestions
openapi: 3.0.0
info:
  title: ZeroClick API
  description: >-
    REST API for managing ZeroClick sellers, services, pricing, usage, and
    analytics. Authenticate with an API key from the ZeroClick dashboard.
  version: 1.0.0
servers:
  - url: https://api.zeroclick.io
security:
  - bearerAuth: []
tags:
  - name: API keys
  - name: Sellers
  - name: Services
  - name: Meters
  - name: Plans
  - name: Plan meter prices
  - name: Usage
  - name: Analytics
  - name: Agentify
  - name: Stripe Connect
  - name: Sandbox
  - name: Organizations
  - name: Users
paths:
  /v1/sellers/{sellerId}/links/suggestions:
    get:
      tags:
        - Sellers
      summary: List website link suggestions
      description: >-
        One run's suggestions (the latest run's unless `run` names another),
        optionally of one status: `open`, `done` (the seller's mark, which
        survives runs) or `applied` (a run found the link on the page).
      parameters:
        - schema:
            type: string
            enum:
              - open
              - done
              - applied
          in: query
          name: status
          required: false
        - schema:
            type: string
            minLength: 1
          in: query
          name: run
          required: false
        - schema:
            type: string
            minLength: 1
          in: path
          name: sellerId
          required: true
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  run:
                    nullable: true
                    type: object
                    properties:
                      id:
                        type: string
                      status:
                        type: string
                        enum:
                          - queued
                          - running
                          - done
                          - failed
                          - cancelled
                      createdAt:
                        type: string
                      startedAt:
                        nullable: true
                        type: string
                      finishedAt:
                        nullable: true
                        type: string
                      coreVersion:
                        type: string
                      judgeModel:
                        type: string
                      writerModel:
                        nullable: true
                        type: string
                      seeds:
                        type: array
                        items:
                          type: string
                      stats:
                        nullable: true
                        type: object
                        properties:
                          discovered:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          selected:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          read:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          proposed:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          alreadyLinked:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          linkStorefront:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          noDestination:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          noPlacement:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          duplicates:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          skipped:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          failed:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          carried:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          applied:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          kinds:
                            type: object
                            properties:
                              article:
                                type: object
                                properties:
                                  found:
                                    type: integer
                                    minimum: -9007199254740991
                                    maximum: 9007199254740991
                                  read:
                                    type: integer
                                    minimum: -9007199254740991
                                    maximum: 9007199254740991
                                required:
                                  - found
                                  - read
                                additionalProperties: false
                              docs:
                                type: object
                                properties:
                                  found:
                                    type: integer
                                    minimum: -9007199254740991
                                    maximum: 9007199254740991
                                  read:
                                    type: integer
                                    minimum: -9007199254740991
                                    maximum: 9007199254740991
                                required:
                                  - found
                                  - read
                                additionalProperties: false
                              marketing:
                                type: object
                                properties:
                                  found:
                                    type: integer
                                    minimum: -9007199254740991
                                    maximum: 9007199254740991
                                  read:
                                    type: integer
                                    minimum: -9007199254740991
                                    maximum: 9007199254740991
                                required:
                                  - found
                                  - read
                                additionalProperties: false
                              never:
                                type: object
                                properties:
                                  found:
                                    type: integer
                                    minimum: -9007199254740991
                                    maximum: 9007199254740991
                                  read:
                                    type: integer
                                    minimum: -9007199254740991
                                    maximum: 9007199254740991
                                required:
                                  - found
                                  - read
                                additionalProperties: false
                            required:
                              - article
                              - docs
                              - marketing
                              - never
                            additionalProperties: false
                          sources:
                            type: object
                            properties:
                              declared:
                                type: integer
                                minimum: -9007199254740991
                                maximum: 9007199254740991
                              sitemaps:
                                type: integer
                                minimum: -9007199254740991
                                maximum: 9007199254740991
                              probes:
                                type: integer
                                minimum: -9007199254740991
                                maximum: 9007199254740991
                              crawl:
                                type: integer
                                minimum: -9007199254740991
                                maximum: 9007199254740991
                            required:
                              - declared
                              - sitemaps
                              - probes
                              - crawl
                            additionalProperties: false
                          judgeCalls:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          writerCalls:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          inputTokens:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          outputTokens:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          edits:
                            type: object
                            properties:
                              linkPhrase:
                                type: integer
                                minimum: -9007199254740991
                                maximum: 9007199254740991
                              addSentence:
                                type: integer
                                minimum: -9007199254740991
                                maximum: 9007199254740991
                              fixed:
                                type: integer
                                minimum: -9007199254740991
                                maximum: 9007199254740991
                            required:
                              - linkPhrase
                              - addSentence
                              - fixed
                            additionalProperties: false
                          firstResultMs:
                            nullable: true
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          ms:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          timedOut:
                            type: boolean
                        required:
                          - discovered
                          - selected
                          - read
                          - proposed
                          - alreadyLinked
                          - noDestination
                          - noPlacement
                          - duplicates
                          - skipped
                          - failed
                          - carried
                          - applied
                          - kinds
                          - sources
                          - judgeCalls
                          - writerCalls
                          - inputTokens
                          - outputTokens
                          - edits
                          - firstResultMs
                          - ms
                          - timedOut
                        additionalProperties: false
                      error:
                        nullable: true
                        type: string
                    required:
                      - id
                      - status
                      - createdAt
                      - startedAt
                      - finishedAt
                      - coreVersion
                      - judgeModel
                      - writerModel
                      - seeds
                      - stats
                      - error
                    additionalProperties: false
                  suggestions:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        runId:
                          type: string
                        page:
                          type: object
                          properties:
                            id:
                              type: string
                            url:
                              type: string
                            title:
                              nullable: true
                              type: string
                            hash:
                              nullable: true
                              type: string
                            capturedAt:
                              nullable: true
                              type: string
                          required:
                            - id
                            - url
                            - title
                            - hash
                            - capturedAt
                          additionalProperties: false
                        blockIndex:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                        start:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                        end:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                        blockHash:
                          type: string
                        section:
                          type: array
                          items:
                            type: string
                        surrounding:
                          nullable: true
                          type: object
                          properties:
                            before:
                              nullable: true
                              type: string
                            after:
                              nullable: true
                              type: string
                          required:
                            - before
                            - after
                          additionalProperties: false
                        kind:
                          type: string
                          enum:
                            - link-phrase
                            - add-sentence
                        anchor:
                          type: string
                        insert:
                          nullable: true
                          type: string
                        before:
                          type: string
                        after:
                          type: string
                        sentence:
                          nullable: true
                          type: object
                          properties:
                            before:
                              type: string
                            after:
                              type: string
                          required:
                            - before
                            - after
                          additionalProperties: false
                        destination:
                          type: object
                          properties:
                            kind:
                              type: string
                            url:
                              type: string
                            name:
                              type: string
                          required:
                            - kind
                            - url
                            - name
                          additionalProperties: false
                        reason:
                          type: string
                        scores:
                          type: object
                          additionalProperties: {}
                        status:
                          type: string
                          enum:
                            - open
                            - done
                            - applied
                        statusChangedAt:
                          nullable: true
                          type: string
                        carriedFrom:
                          nullable: true
                          type: string
                        createdAt:
                          type: string
                      required:
                        - id
                        - runId
                        - page
                        - blockIndex
                        - start
                        - end
                        - blockHash
                        - section
                        - surrounding
                        - kind
                        - anchor
                        - insert
                        - before
                        - after
                        - sentence
                        - destination
                        - reason
                        - scores
                        - status
                        - statusChangedAt
                        - carriedFrom
                        - createdAt
                      additionalProperties: false
                required:
                  - run
                  - suggestions
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    enum:
                      - organization_required
                      - feature_not_enabled
                      - seller_not_found
                      - run_not_found
                      - run_finished
                      - suggestion_not_found
                      - suggestion_applied
                      - ai_not_configured
                      - website_required
                  note:
                    type: string
                required:
                  - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    enum:
                      - organization_required
                      - feature_not_enabled
                      - seller_not_found
                      - run_not_found
                      - run_finished
                      - suggestion_not_found
                      - suggestion_applied
                      - ai_not_configured
                      - website_required
                  note:
                    type: string
                required:
                  - error
                additionalProperties: false
        '409':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    enum:
                      - organization_required
                      - feature_not_enabled
                      - seller_not_found
                      - run_not_found
                      - run_finished
                      - suggestion_not_found
                      - suggestion_applied
                      - ai_not_configured
                      - website_required
                  note:
                    type: string
                required:
                  - error
                additionalProperties: false
        '503':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    enum:
                      - organization_required
                      - feature_not_enabled
                      - seller_not_found
                      - run_not_found
                      - run_finished
                      - suggestion_not_found
                      - suggestion_applied
                      - ai_not_configured
                      - website_required
                  note:
                    type: string
                required:
                  - error
                additionalProperties: false
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key created in the ZeroClick dashboard under Settings → API keys.
        Keys start with `zc_`. Send them as `Authorization: Bearer zc_...`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.