---
title: "Retrieve proforma public link"
method: GET
path: "/companies/{company}/proformas/{proforma}/public-link"
tags: ["Proformas"]
---

# Retrieve proforma public link

`GET /companies/{company}/proformas/{proforma}/public-link`

## Request

- Base URL: `https://api.factuarea.com/v1`
- URL: `https://api.factuarea.com/v1/companies/{company}/proformas/{proforma}/public-link`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Returns the shareable public URL of the proforma along with its status, expiration, and the plan-allowed maximum extension days.

## Path parameters

- `company` string, uuid, required
- `proforma` string, uuid, required

## Headers

- `Factuarea-Version` string, date

## Response `200`

- object
  - `data` PublicLink, required: Represents the state of the shareable public link of a document (quote/invoice/proforma/delivery_note). `url` is the absolute URL ready to send to the client; `enabled` indicates whether it is active; `expires_at` the deadline (`null` = unlimited); `max_days` the maximum allowed when extending it.
    - `object` 'public_link', required
    - `url` string, uri, required: Absolute URL of the public link to share with the client.
    - `id` string, required: UUID v7 of the document the link points to.
    - `enabled` boolean, required: Indicates whether the public link is currently active.
    - `expires_at` string, date-time, nullable, required: Expiration date/time of the link, or `null` if it does not expire.
    - `max_days` integer, required: Maximum number of days allowed when extending the link validity (business limit).

## Other responses

- `400`: `parameter_unknown` with `subcode` `retired_active_profile_header`: the retired `X-Active-Profile` header was sent; the company goes in the path. `parameter_invalid_format` on `Factuarea-Version`: the header is not a `YYYY-MM-DD` date. `unsupported_api_version`: the `Factuarea-Version` date is not a supported version.
- `401`: Missing or invalid API key.
- `403`: The request is authenticated but not allowed: the API key lacks the required scope (`insufficient_scope`), the plan does not include the public API or this feature (`addon_not_active`, `feature_not_available_in_plan`), or the module is not available with a test key (`module_not_available_in_sandbox`).
- `404`: The requested resource does not exist or belongs to another company.
- `429`: Rate limit exceeded. Retry after the duration in `Retry-After`.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/factuarea/apis/factuarea-public-api.md) · [All operations](https://skmtc.dev/factuarea/apis/factuarea-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/factuarea/apis/factuarea-public-api/revisions/718e77934422?raw)