links

List the documents a public link has produced

Lists the completed documents produced by this link — one per person who opened it and signed.

Each entry carries a documentId you can pass straight to GET /docs/{documentId}, GET /docs/{documentId}/signed-file and the rest of the document endpoints.

Only completed submissions

Someone who opened the link and abandoned it half-filled does not appear here. A link anyone can open would otherwise fill this listing with noise, and there is no meaningful "in progress" state for a signer nobody invited.

These documents are not part of GET /docs, which lists documents you sent to named recipients.

get/links/{linkId}/documents

Request

  • Base URL: https://docs-api.formify.eu/v1
  • URL: https://docs-api.formify.eu/v1/links/{linkId}/documents
  • Auth: OAuth 2 (authorization code, authorization URL https://docs-api.formify.eu/v1/oauth/authorize, token URL https://docs-api.formify.eu/v1/oauth/token)

Path parameters

linkIdstring uuid required

The unique identifier of the public link.

Query parameters

limitinteger

Number of documents to retrieve per request (max 50)

offsetinteger

Number of items to skip before starting to collect the result set

errorLanguage'en' | 'sv' | 'es'

Language for the error message

Response

List of documents produced by the link

limitinteger

The maximum number of documents requested per page

offsetinteger

The offset used in the current request

nextOffsetinteger nullable

The offset to use for the next page, or null when there are no more results.

A page can come back with fewer items than limit. Follow nextOffset until it is null rather than stopping at the first short page.

errorLanguagestring

Changes

No recorded changes to this operation across all 1 revision of this API.