List signed contracts

GET/v1/portal/contracts

Coming March 2027

This endpoint ships in March 2027. The shape shown here can still change before release.

Returns the client's contracts with this business, with a download of each sealed PDF.

GET /v1/portal/contracts/{id}/pdf downloads the sealed PDF. Its SHA-256 hash is checked on every download; if the file does not match the stored hash the download fails with contract_hash_mismatch and an alert is raised. Signed contracts never change: a change is a new version that is signed again. See Contracts and e-signature.

Permission: client scope
Type: Read-only. Changes nothing.
Auth: Client portal session
Capability: portal_list_contracts
Available: From March 2027

portal_list_contracts

curl --request GET \
  --url https://api.freeinvoiceautomation.com/v1/portal/contracts \
  --cookie 'fia_portal=<portal-session>'

{
  "data": [
    {
      "id": "0193f7b1-6c7d-7e8f-8a91-0b1c2d3e4f50",
      "number": "CTR-2027-0002",
      "status": "sealed",
      "version": 1,
      "sealed_at": "2027-03-15T14:02:00Z",
      "pdf_url": "/v1/portal/contracts/0193f7b1-6c7d-7e8f-8a91-0b1c2d3e4f50/pdf"
    }
  ],
  "next_cursor": null,
  "has_more": false
}

Authorizations

fia_portalcookierequired

Client portal session cookie set by open_portal_session.

Query Parameters

limitintegerdefault:50

Page size, 1 to 200.

cursorstring

Cursor from the previous page's next_cursor.

Response

200 - application/json

dataobject[]

The contracts on this page.

next_cursorstring | null

Cursor for the next page, or null on the last page.

has_moreboolean

Whether another page exists.

Errors

unauthenticated

contract_hash_mismatch

not_found

Plus the common errors every call can return. See Errors.

Suggest edits Raise issue

Remove a saved cardPrevious End the portal sessionNext

portal_list_contracts

curl --request GET \
  --url https://api.freeinvoiceautomation.com/v1/portal/contracts \
  --cookie 'fia_portal=<portal-session>'

{
  "data": [
    {
      "id": "0193f7b1-6c7d-7e8f-8a91-0b1c2d3e4f50",
      "number": "CTR-2027-0002",
      "status": "sealed",
      "version": 1,
      "sealed_at": "2027-03-15T14:02:00Z",
      "pdf_url": "/v1/portal/contracts/0193f7b1-6c7d-7e8f-8a91-0b1c2d3e4f50/pdf"
    }
  ],
  "next_cursor": null,
  "has_more": false
}