Proformas

Retrieve proforma public link

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

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

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

proformastring uuid required

Public identifier (UUID v7) of the proforma.

Headers

Factuarea-Versionstring date

Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Response

Example response

{
  "data": {
    "object": "public_link",
    "url": "https://app.factuarea.com/p/quotes/01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a04",
    "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a04",
    "enabled": true,
    "expires_at": "2026-04-15T23:59:59Z",
    "max_days": 180
  }
}

Changes

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