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

# List public links

`GET /links`

## Request

- Base URL: `https://docs-api.formify.eu/v1`
- URL: `https://docs-api.formify.eu/v1/links`
- 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`)

Retrieves a paginated list of the public links you own, plus the ones shared with the account.

Requires the `publicLinks` capability. Check `GET /account/capabilities`.

## Query parameters

- `limit` integer
- `offset` integer
- `errorLanguage` 'en' | 'sv' | 'es'

## Response `200`

List of public links fetched successfully

- PublicLinkListResponse
  - `limit` integer: The maximum number of links requested per page
  - `offset` integer: The offset used in the current request
  - `nextOffset` integer, 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.
  - `links` PublicLinkListDetail[]
    - `linkId` string, uuid: Unique identifier of the public link
    - `name` string: Name of the link
    - `createdAt` string, date-time: When the link was created
    - `updatedAt` string, date-time, nullable: When the link was last edited
    - `userId` string, uuid: User ID of the link owner
    - `sharingSetting` 'shared' | 'private': Who on the account may administer the link
    - `status` 'active' | 'disabled' | 'processing': - `active`: the link is live and can be opened and signed. - `disabled`: the link has been switched off and no longer accepts new signers. Documents already produced by it are unaffected. There is no way to switch it back on. - `processing`: the AI assistant is still reading the document. `linkUrl` is `null` and the link cannot be edited until this finishes. Note this is a different set of values from a document's `status` — a link is a source of documents rather than a signature request, so it has no signing progress of its own.
    - `linkUrl` string, nullable: The link to share. `null` while `status` is `processing`, because the document is not servable yet. Uses the account's custom domain when one is configured. Formify never sends this to anyone — distributing it is up to you.
  - `errorLanguage` string

## Other responses

- `401`: Unauthorized - Missing or invalid access token.
- `403`: Forbidden - the account does not have the `publicLinks` capability.
- `500`: Internal server error

---

[API](https://skmtc.dev/formify/apis/formify-api.md) · [All operations](https://skmtc.dev/formify/apis/formify-api/llms.txt) · [OpenAPI document](https://skmtc.dev/formify/apis/formify-api/revisions/571c4c0d4f4f?raw)