Formality API

aid: formality-api
name: Formality API
description: 'The Formality REST API exposes the workspace contract repository so external tools and AI
  agents can retrieve documents and the AI-extracted metadata layer. Every path is namespaced to a workspace
  — /api/v1/{workspaceId}/ — and the documented resources cover agreements and agreement fields, with
  the help centre describing coverage of agreements, counterparties and related entities. Access uses
  a two-step bearer flow: an administrator mints a long-lived personal Refresh Token in Personal Settings
  > Formality API, then exchanges it at GET /api/v1/token for a 5-minute access token used as Authorization:
  Bearer on subsequent calls. A Swagger UI is published at /-/api-doc-swagger but is reachable only after
  authenticating.'
humanURL: https://help.formality.com/integrations/api
baseURL: https://app.eu1.formality.com/api/v1/{workspaceId}
tags:
- Contract Management
- Documents
- Legal
- Agreements
properties:
- type: APIReference
  url: https://help.formality.com/integrations/api
- type: Authentication
  url: authentication/formality-authentication.yml
- type: ErrorCatalog
  url: errors/formality-problem-types.yml
- type: Conventions
  url: conventions/formality-conventions.yml
- type: DataModel
  url: data-model/formality-data-model.yml
- type: Webhooks
  url: asyncapi/formality-webhooks.yml
x-base-url-note: The help centre publishes the base as https://app.formality.com/api/v1/{workspaceId}/,
  but app.formality.com does not resolve in DNS (2026-08-17). The live regional application hosts named
  on Formality's own status page are app.eu1.formality.com (EU/Ireland) and app.fr1.formality.com (France/Scaleway);
  both answer /api/v1/... with HTTP 401 rather than 404, so the EU host is recorded here and the documented
  generic host is flagged as a provider-side documentation defect.