Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
title: Lexifina External Documents.versions API
description: 'Scoped personal API keys. Existing ownership, account security and usage quotas apply. Required scopes are listed on each operation.
Every successful JSON response has one shape. A resource is returned as itself, with `id` and `object` (its type, such as `"invoice"`). A list is `{"object": "list", "data": [...], "has_more", "next_cursor", "first_id", "last_id"}`; pass `next_cursor` as `after` for the next page. A deletion is `{"id", "object", "deleted": true}`. Downloads are the file itself. Timestamps are ISO 8601 in UTC, ending in `Z`. Errors are `{"error": {"type", "code", "message", "retryable", "fields", "details"}, "request_id"}`: branch on `type`, retry only when `retryable` is true. Ignore fields you do not recognise.
Typical agent flow: start a run on a document (`runs.create`), poll it (`runs.retrieve`) until `is_terminal` or subscribe to run webhooks, then open a review with the run''s `run_id` and resolve every proposal. Read documents as plain text with the text operation; section identifiers are shared by text, citations, proposals and section edits.
Writes accept Idempotency-Key for JSON requests up to 1 MiB. A retry with the same key and body returns the first response; a request refused before it changed anything (a retryable error) can be retried with the same key; an outcome that is unknown (`outcome_unknown`) is never re-executed: read the resource, then use a new key. Send `X-Client-Request-Id` to have your own identifier echoed and logged.
Versions are dates. Send `Lexifina-Version` to choose one; without it a request runs at the version its key was created with. Every response names the version that served it. New operations, optional fields, response fields, enum values, error codes and event types are added without a new version; ignore what you do not recognise. Operations marked beta (`x-beta`, and a `Lexifina-Beta: true` response header) may change without a new version.'
version: '2026-10-21'
x-versions:
- '2026-10-14'
- '2026-10-21'
x-changelog:
- date: '2026-10-25'
version: null
kind: added
text: 'Comments and tracked changes: documents.comments.list, create, reply, resolve and reopen; documents.tracked_changes.list, create, accept and reject. documents.sections.update_text takes mode=suggest to record an edit as tracked changes. What an integration writes is attributed to the key''s owner.'
- date: '2026-10-25'
version: null
kind: added
text: 'Webhooks through the API (scopes webhooks:read and webhooks:write): webhook_endpoints.list, retrieve, create, update, delete, rotate_secret and test, webhook_endpoints.deliveries.list and redeliver, and webhook_events.list.'
- date: '2026-10-25'
version: null
kind: added
text: 'API keys through the API (scopes keys:read and keys:write): api_keys.list and retrieve, api_keys.create for a key with no more access than the calling key, api_keys.update, api_keys.roll to replace a secret, and api_keys.revoke.'
- date: '2026-10-22'
version: null
kind: added
text: 'The spec describes everything a client library needs: every response field is listed as present (null where it can be), run items are a union told apart by item_type and the run stream''s events one told apart by type (runs.events.stream publishes RunStreamFrame), each event type''s webhook body is under webhooks, and response headers (X-Request-ID, Lexifina-Version, rate limits, Idempotency-Replayed) are documented. openapi-v1.overlay.json adds what SDK generators need: paging, retries and SDK names.'
- date: '2026-10-22'
version: null
kind: changed
text: portal.messages.list, finance.rates.list, runs.directions.list, workflow_runs.logs, search.documents and search.sections take limit and after like every other list. Runs list only the published kinds of item (user_message, agent_message, thinking, tool, stage and subagent).
- date: '2026-10-22'
version: null
kind: changed
text: 'Every operation has a resource path with snake_case segments and {resource_id} parameters: /matters/{matter_id} (was /intakes/instances/{instance_id} and /intakes/matters/{instance_id}), /signature_requests (was /esign/envelopes), /workflows and /workflow_runs (was /automation-flows), /runs and /sessions (was /agentic), /documents/{document_id}/reviews and /documents/{document_id}/comparisons, /questionnaire_templates. Operations follow their paths: signature_requests.*, workflow_runs.*, workflow_interventions.*, questionnaire_templates.*, portal.invitations.create, documents.processing, documents.versions.retrieve and documents.versions.create. The old paths keep working, unpublished, and answer with Deprecation, Lexifina-Replaced-By and a Link to the new path. info.x-deprecated in the spec lists each.'
- date: '2026-10-22'
version: null
kind: added
text: 'One operation per job: documents.create (an upload, editor JSON, a template, or empty), documents.transform (all page and PDF tools, on uploads or stored documents), redactions.create (a document, a file or content; dry_run to check), translations.create (content or sections), matters.update (details, contacts and custom fields together), finance.invoices.download (format=pdf or ledes), and documents.compare and documents.download formats (diff, docx; pdf). Invoices and payments gain list and retrieve; usage.limits gives the agent allowance without a document. Lists of documents, clients, matters, runs and signature requests take ?external_id=, and their creates and updates take external_reference.'
- date: '2026-10-22'
version: null
kind: deprecated
text: 'The operations those replace: documents.upload, create_empty, create_from_template and create_with_content; the ten page and PDF operations; redactions.preview, create_from_upload and the document-path create; translations.preview and translate_sections; documents.versions.history, redline, redline_from_parent and export_pdf; the five retrieve_by_external_id operations; matters.update_details, update_client_info, update_contacts and update_custom_fields; matters.tasks.complete, reopen and cancel (use tasks.update with a status); finance.invoices.pdf and ledes; usage.agent_allowance. They keep working until a later dated version removes them.'
- date: '2026-10-21'
version: '2026-10-21'
kind: version
text: 'One response shape for every operation: a resource is returned as itself with id and object; a list is {object: "list", data, has_more, next_cursor, first_id, last_id}; a deletion is {id, object, deleted: true}; timestamps are UTC with Z. Wrapped results such as {"invoice": {...}} are unwrapped, and responses carry only their published fields. runs.create returns the run. Background jobs share one status vocabulary (queued, running, requires_action, completed, failed, cancelled): comparisons and workflow runs use it, with the original in status_detail. A review''s expires_at is a timestamp. Objects are named for what they are: signature_request (was envelope), workflow_run and workflow_run_event (were workflow_execution...), questionnaire_template (was template), and the redaction and translation logs'' redaction_entry and translation_entry.'
- date: '2026-10-22'
version: null
kind: added
text: 'runs.events.stream: a run''s events as Server-Sent Events, resumable with Last-Event-ID.'
- date: '2026-10-22'
version: null
kind: deprecated
text: documents.catalog (use documents.list), documents.versions.compare (use documents.compare), sessions.list_for_document (use sessions.list), sessions.goal.pause and sessions.goal.resume (use sessions.goal.update). They keep working; responses carry Deprecation and Lexifina-Replaced-By headers.
- date: '2026-10-22'
version: null
kind: added
text: error.param names the first invalid field.
- date: '2026-10-21'
version: null
kind: added
text: finance.rates.list, finance.rates.create, finance.rates.update and finance.rates.archive, so time recorded through the API can be priced and invoiced.
- date: '2026-10-21'
version: null
kind: changed
text: X-Client-Request-Id is echoed and logged with each request; X-Request-ID values are longer.
- date: '2026-10-14'
version: '2026-10-14'
kind: version
text: First public version.
x-deprecated:
- method: GET
path: /documents/list
replaced_by: documents.list
deprecated_on: '2026-10-22'
- method: GET
path: /documents/metadata/facets
replaced_by: documents.facets
deprecated_on: '2026-10-22'
- method: GET
path: /documents/{document_id}/section/{section_id}/metadata
replaced_by: documents.sections.metadata
deprecated_on: '2026-10-22'
- method: GET
path: /documents/{document_id}/section/{section_id}/preview
replaced_by: documents.sections.content
deprecated_on: '2026-10-22'
- method: GET
path: /documents/{document_id}/section/{section_id}/docx
replaced_by: documents.sections.download
deprecated_on: '2026-10-22'
- method: GET
path: /documents/{document_id}/document-metadata/status
replaced_by: documents.processing
deprecated_on: '2026-10-22'
operation: documents.analysis_status
- method: GET
path: /documents/{document_id}/version/{version_number}/metadata
replaced_by: documents.versions.retrieve
deprecated_on: '2026-10-22'
operation: documents.versions.metadata
- method: GET
path: /documents/{document_id}/clauses/history-index
replaced_by: documents.clauses.list
deprecated_on: '2026-10-22'
- method: GET
path: /documents/{document_id}/length-readability
replaced_by: documents.readability
deprecated_on: '2026-10-22'
- operation: documents.catalog
method: GET
path: /documents/catalog-page
replaced_by: documents.list
deprecated_on: '2026-10-21'
- operation: documents.versions.history
method: GET
path: /documents/{document_id}/version-history
replaced_by: documents.compare
deprecated_on: '2026-10-22'
- operation: documents.versions.redline
method: GET
path: /documents/{document_id}/diff-file
replaced_by: documents.compare
deprecated_on: '2026-10-22'
- operation: documents.versions.redline_from_parent
method: GET
path: /documents/{document_id}/auto-diff-file
replaced_by: documents.compare
deprecated_on: '2026-10-22'
- operation: documents.export_pdf
method: GET
path: /export/pdf/{document_id}
replaced_by: documents.download
deprecated_on: '2026-10-22'
- operation: documents.retrieve_by_external_id
method: GET
path: /documents/by-external-id/{external_id}
replaced_by: documents.list
deprecated_on: '2026-10-22'
- method: POST
path: /documents/{document_id}/save
replaced_by: documents.versions.create
deprecated_on: '2026-10-22'
operation: documents.versions.upload
- method: PUT
path: /documents/{document_id}/section/{section_id}/text
replaced_by: documents.sections.update_text
deprecated_on: '2026-10-22'
- method: PUT
path: /documents/{document_id}/metadata
replaced_by: documents.update
deprecated_on: '2026-10-22'
- method: PUT
path: /documents/{document_id}/section/{section_id}/metadata
replaced_by: documents.sections.update_metadata
deprecated_on: '2026-10-22'
- method: PUT
path: /documents/{document_id}/external-reference
replaced_by: documents.set_external_reference
deprecated_on: '2026-10-22'
- operation: documents.upload
method: POST
path: /documents/upload
replaced_by: documents.create
deprecated_on: '2026-10-22'
- operation: documents.create_from_template
method: POST
path: /documents/create-blank
replaced_by: documents.create
deprecated_on: '2026-10-22'
- operation: documents.create_empty
method: POST
path: /documents/create-empty
replaced_by: documents.create
deprecated_on: '2026-10-22'
- operation: documents.create_with_content
method: POST
path: /documents/create-initialized
replaced_by: documents.create
deprecated_on: '2026-10-22'
- operation: documents.versions.compare
method: POST
path: /documents/{document_id}/diff
replaced_by: documents.compare
deprecated_on: '2026-10-21'
- method: POST
path: /documents/conversions/uploads
replaced_by: conversions.create
deprecated_on: '2026-10-22'
- method: GET
path: /documents/{document_id}/redaction-status
replaced_by: redactions.status
deprecated_on: '2026-10-22'
- method: GET
path: /documents/redactions/entity-policies
replaced_by: redactions.entity_types
deprecated_on: '2026-10-22'
- method: GET
path: /documents/translations/languages
replaced_by: translations.languages
deprecated_on: '2026-10-22'
- operation: documents.combine
method: POST
path: /documents/compositions/uploads
replaced_by: documents.transform
deprecated_on: '2026-10-22'
- operation: documents.combine_pdfs
method: POST
path: /documents/pdf-compositions/uploads
replaced_by: documents.transform
deprecated_on: '2026-10-22'
- operation: documents.extract_pdf_pages
method: POST
path: /documents/pdf-compositions/extractions/uploads
replaced_by: documents.transform
deprecated_on: '2026-10-22'
- operation: documents.extract_pages
method: POST
path: /documents/page-extractions/uploads
replaced_by: documents.transform
deprecated_on: '2026-10-22'
- operation: documents.extract_pages_batch
method: POST
path: /documents/page-extractions/uploads/batch
replaced_by: documents.transform
deprecated_on: '2026-10-22'
- operation: documents.reorder_pages
method: POST
path: /documents/page-orderings/uploads
replaced_by: documents.transform
deprecated_on: '2026-10-22'
- operation: documents.clean_metadata
method: POST
path: /documents/metadata-cleanings/uploads
replaced_by: documents.transform
deprecated_on: '2026-10-22'
- operation: documents.optimize_pdf
method: POST
path: /documents/pdf-optimizations/uploads
replaced_by: documents.transform
deprecated_on: '2026-10-22'
- operation: documents.ocr_upload
method: POST
path: /documents/ocr/uploads
replaced_by: documents.transform
deprecated_on: '2026-10-22'
- operation: documents.ocr
method: POST
path: /documents/ocr/sources/{source_document_id}
replaced_by: documents.transform
deprecated_on: '2026-10-22'
- operation: redactions.preview
method: POST
path: /documents/redact-preview
replaced_by: redactions.create
deprecated_on: '2026-10-22'
- operation: redactions.create_from_upload
method: POST
path: /documents/redact-upload
replaced_by: redactions.create
deprecated_on: '2026-10-22'
- operation: redactions.create_for_document
method: POST
path: /documents/{document_id}/redact
replaced_by: redactions.create
deprecated_on: '2026-10-22'
- operation: translations.preview
method: POST
path: /documents/translate-preview
replaced_by: translations.create
deprecated_on: '2026-10-22'
- operation: translations.translate_sections
method: POST
path: /documents/translate-sections
replaced_by: translations.create
deprecated_on: '2026-10-22'
- method: POST
path: /documents/{document_id}/analyze-risks
replaced_by: analysis.risks
deprecated_on: '2026-10-22'
- method: POST
path: /documents/{document_id}/analyze-structure
replaced_by: analysis.structure
deprecated_on: '2026-10-22'
- method: POST
path: /documents/{document_id}/analyze-keywords
replaced_by: analysis.keywords
deprecated_on: '2026-10-22'
- method: POST
path: /documents/{document_id}/summarize-diff
replaced_by: analysis.summarize_change
deprecated_on: '2026-10-22'
- method: POST
path: /semantic-comparison/{document_id}
replaced_by: comparisons.create
deprecated_on: '2026-10-22'
- method: POST
path: /semantic-comparison/{document_id}/metadata-comparison
replaced_by: comparisons.create_metadata
deprecated_on: '2026-10-22'
- method: GET
path: /semantic-comparison/{document_id}/{task_id}
replaced_by: comparisons.retrieve
deprecated_on: '2026-10-22'
- method: GET
path: /semantic-comparison/{document_id}/metadata-comparison/{task_id}
replaced_by: comparisons.retrieve_metadata
deprecated_on: '2026-10-22'
- method: GET
path: /client-portal/firm/matters/{matter_id}/messages
replaced_by: portal.messages.list
deprecated_on: '2026-10-22'
- operation: clients.retrieve_by_external_id
method: GET
path: /clients/by-external-id/{external_id}
replaced_by: clients.list
deprecated_on: '2026-10-22'
- method: PUT
path: /clients/{client_id}/external-reference
replaced_by: clients.set_external_reference
deprecated_on: '2026-10-22'
- method: POST
path: /client-portal/firm/matters/{matter_id}/access
replaced_by: portal.invitations.create
deprecated_on: '2026-10-22'
operation: portal.invites.create
- method: POST
path: /client-portal/firm/matters/{matter_id}/messages
replaced_by: portal.messages.create
deprecated_on: '2026-10-22'
- method: GET
path: /intakes/instances
replaced_by: matters.list
deprecated_on: '2026-10-22'
- method: GET
path: /intakes/instances/{instance_id}
replaced_by: matters.retrieve
deprecated_on: '2026-10-22'
- method: GET
path: /intakes/instances/{instance_id}/status
replaced_by: matters.status
deprecated_on: '2026-10-22'
- method: GET
path: /intakes/instances/{instance_id}/questionnaires
replaced_by: matters.questionnaires.list
deprecated_on: '2026-10-22'
- method: GET
path: /intakes/matters/{instance_id}/overview
replaced_by: matters.overview
deprecated_on: '2026-10-22'
- method: GET
path: /intakes/matters/{instance_id}/tasks
replaced_by: matters.tasks.list
deprecated_on: '2026-10-22'
- method: GET
path: /intakes/matters/{instance_id}/events
replaced_by: matters.events.list
deprecated_on: '2026-10-22'
- method: GET
path: /intakes/matter-custom-fields
replaced_by: matters.field_definitions
deprecated_on: '2026-10-22'
- method: GET
path: /intakes/matter-profiles
replaced_by: matters.profiles
deprecated_on: '2026-10-22'
- operation: matters.retrieve_by_external_id
method: GET
path: /intakes/instances/by-external-id/{external_id}
replaced_by: matters.list
deprecated_on: '2026-10-22'
- method: POST
path: /intakes/instances
replaced_by: matters.create
deprecated_on: '2026-10-22'
- method: POST
path: /intakes/instances/{instance_id}/attach-template
replaced_by: matters.questionnaires.attach
deprecated_on: '2026-10-22'
- method: PUT
path: /intakes/instances/{instance_id}/answers
replaced_by: matters.questionnaires.save_answers
deprecated_on: '2026-10-22'
- method: POST
path: /intakes/instances/{instance_id}/submit
replaced_by: matters.questionnaires.submit
deprecated_on: '2026-10-22'
- method: POST
path: /intakes/instances/{instance_id}/close
replaced_by: matters.close
deprecated_on: '2026-10-22'
- method: POST
path: /intakes/instances/{instance_id}/reopen
replaced_by: matters.reopen
deprecated_on: '2026-10-22'
- method: POST
path: /intakes/instances/{instance_id}/attach-document
replaced_by: matters.documents.attach
deprecated_on: '2026-10-22'
- method: DELETE
path: /intakes/instances/{instance_id}/detach-document/{document_id}
replaced_by: matters.documents.detach
deprecated_on: '2026-10-22'
- method: POST
path: /intakes/instances/{instance_id}/files
replaced_by: matters.files.upload
deprecated_on: '2026-10-22'
- method: POST
path: /intakes/matters/{instance_id}/tasks
replaced_by: matters.tasks.create
deprecated_on: '2026-10-22'
- method: PATCH
path: /intakes/matters/{instance_id}/tasks/{task_id}
replaced_by: matters.tasks.update
deprecated_on: '2026-10-22'
- method: POST
path: /intakes/matters/{instance_id}/events
replaced_by: matters.events.create
deprecated_on: '2026-10-22'
- method: PUT
path: /intakes/instances/{instance_id}/external-reference
replaced_by: matters.set_external_reference
deprecated_on: '2026-10-22'
- operation: matters.update_details
method: PATCH
path: /intakes/matters/{instance_id}/details
replaced_by: matters.update
deprecated_on: '2026-10-22'
- operation: matters.update_client_info
method: PUT
path: /intakes/instances/{instance_id}/client-info
replaced_by: matters.update
deprecated_on: '2026-10-22'
- operation: matters.update_contacts
method: PATCH
path: /intakes/matters/{instance_id}/contacts
replaced_by: matters.update
deprecated_on: '2026-10-22'
- operation: matters.update_custom_fields
method: PATCH
path: /intakes/matters/{instance_id}/custom-fields
replaced_by: matters.update
deprecated_on: '2026-10-22'
- operation: matters.tasks.complete
method: POST
path: /intakes/matters/{instance_id}/tasks/{task_id}/complete
replaced_by: matters.tasks.update
deprecated_on: '2026-10-22'
- operation: matters.tasks.reopen
method: POST
path: /intakes/matters/{instance_id}/tasks/{task_id}/reopen
replaced_by: matters.tasks.update
deprecated_on: '2026-10-22'
- operation: matters.tasks.cancel
method: POST
path: /intakes/matters/{instance_id}/tasks/{task_id}/cancel
replaced_by: matters.tasks.update
deprecated_on: '2026-10-22'
- method: DELETE
path: /intakes/instances/{instance_id}
replaced_by: matters.delete
deprecated_on: '2026-10-22'
- method: GET
path: /intakes/templates
replaced_by: questionnaire_templates.list
deprecated_on: '2026-10-22'
operation: templates.list
- method: GET
path: /intakes/templates/{template_id}
replaced_by: questionnaire_templates.retrieve
deprecated_on: '2026-10-22'
operation: templates.retrieve
- method: GET
path: /intakes/templates/{template_id}/export
replaced_by: questionnaire_templates.export
deprecated_on: '2026-10-22'
operation: templates.export
- method: POST
path: /intakes/templates
replaced_by: questionnaire_templates.create
deprecated_on: '2026-10-22'
operation: templates.create
- method: PUT
path: /intakes/templates/{template_id}
replaced_by: questionnaire_templates.update
deprecated_on: '2026-10-22'
operation: templates.update
- method: POST
path: /intakes/templates/{template_id}/duplicate
replaced_by: questionnaire_templates.duplicate
deprecated_on: '2026-10-22'
operation: templates.duplicate
- method: POST
path: /search/everything
replaced_by: search.everything
deprecated_on: '2026-10-22'
- method: POST
path: /sparse-search/text-search
replaced_by: search.sections
deprecated_on: '2026-10-22'
- method: POST
path: /sparse-search/document-search
replaced_by: search.documents
deprecated_on: '2026-10-22'
- method: GET
path: /documents/clause-library
replaced_by: search.clause_library
deprecated_on: '2026-10-22'
- method: GET
path: /agentic/sessions
replaced_by: sessions.list
deprecated_on: '2026-10-22'
- method: GET
path: /agentic/runs/{run_id}/events
replaced_by: runs.events.stream
deprecated_on: '2026-10-22'
- method: GET
path: /agentic/runs/{run_id}
replaced_by: runs.retrieve
deprecated_on: '2026-10-22'
- method: GET
path: /agentic/runs
replaced_by: runs.list
deprecated_on: '2026-10-22'
- method: GET
path: /agentic/runs/{run_id}/directions
replaced_by: runs.directions.list
deprecated_on: '2026-10-22'
- method: GET
path: /agentic/skills
replaced_by: skills.list
deprecated_on: '2026-10-22'
- method: GET
path: /agentic/sessions/{session_id}/goal
replaced_by: sessions.goal.retrieve
deprecated_on: '2026-10-22'
- operation: sessions.list_for_document
method: GET
path: /agentic/{document_id}/sessions
replaced_by: sessions.list
deprecated_on: '2026-10-21'
- operation: runs.retrieve_by_external_id
method: GET
path: /agentic/runs/by-external-id/{external_id}
replaced_by: runs.list
deprecated_on: '2026-10-22'
- operation: usage.agent_allowance
method: GET
path: /agentic/{document_id}/usage
replaced_by: usage.limits
deprecated_on: '2026-10-22'
- method: POST
path: /agentic/{document_id}/sessions
replaced_by: sessions.create
deprecated_on: '2026-10-22'
- method: POST
path: /agentic/runs
replaced_by: runs.create
deprecated_on: '2026-10-22'
- method: POST
path: /agentic/runs/{run_id}/user-input
replaced_by: runs.submit_user_input
deprecated_on: '2026-10-22'
- method: POST
path: /agentic/runs/{run_id}/directions
replaced_by: runs.directions.create
deprecated_on: '2026-10-22'
- method: PUT
path: /agentic/sessions/{session_id}/goal
replaced_by: sessions.goal.set
deprecated_on: '2026-10-22'
- method: PATCH
path: /agentic/sessions/{session_id}/goal
replaced_by: sessions.goal.update
deprecated_on: '2026-10-22'
- method: POST
path: /agentic/runs/{run_id}/cancel
replaced_by: runs.cancel
deprecated_on: '2026-10-22'
- method: PUT
path: /agentic/runs/{run_id}/external-reference
replaced_by: runs.set_external_reference
deprecated_on: '2026-10-22'
- operation: sessions.goal.pause
method: POST
path: /agentic/sessions/{session_id}/goal/pause
replaced_by: sessions.goal.update
deprecated_on: '2026-10-21'
- operation: sessions.goal.resume
method: POST
path: /agentic/sessions/{session_id}/goal/resume
replaced_by: sessions.goal.update
deprecated_on: '2026-10-21'
- method: POST
path: /agentic/changes/{document_id}/reviews
replaced_by: reviews.create
deprecated_on: '2026-10-22'
- method: POST
path: /agentic/changes/{document_id}/reviews/{review_operation_id}/resolve
replaced_by: reviews.resolve
deprecated_on: '2026-10-22'
- method: POST
path: /agentic/changes/{document_id}/reviews/{review_operation_id}/abandon
replaced_by: reviews.abandon
deprecated_on: '2026-10-22'
- method: GET
path: /automation-flows/capabilities
replaced_by: workflows.capabilities
deprecated_on: '2026-10-22'
- method: GET
path: /automation-flows/recipes
replaced_by: workflows.recipes
deprecated_on: '2026-10-22'
- method: GET
path: /automation-flows
replaced_by: workflows.list
deprecated_on: '2026-10-22'
- method: GET
path: /automation-flows/{flow_id}
replaced_by: workflows.retrieve
deprecated_on: '2026-10-22'
- method: GET
path: /automation-flows/executions
replaced_by: workflow_runs.list
deprecated_on: '2026-10-22'
operation: workflows.executions.list
- method: GET
path: /automation-flows/executions/{execution_id}
replaced_by: workflow_runs.retrieve
deprecated_on: '2026-10-22'
operation: workflows.executions.retrieve
- method: GET
path: /automation-flows/executions/{execution_id}/logs
replaced_by: workflow_runs.logs
deprecated_on: '2026-10-22'
operation: workflows.executions.logs
- method: GET
path: /automation-flows/executions/{execution_id}/interventions
replaced_by: workflow_runs.interventions.list
deprecated_on: '2026-10-22'
operation: workflows.executions.list_interventions
- method: POST
path: /automation-flows
replaced_by: workflows.create
deprecated_on: '2026-10-22'
- method: PUT
path: /automation-flows/{flow_id}
replaced_by: workflows.update
deprecated_on: '2026-10-22'
- method: POST
path: /automation-flows/{flow_id}/compile
replaced_by: workflows.compile
deprecated_on: '2026-10-22'
- method: POST
path: /automation-flows/{flow_id}/manual-activate
replaced_by: workflows.start
deprecated_on: '2026-10-22'
- method: POST
path: /automation-flows/executions/{execution_id}/cancel
replaced_by: workflow_runs.cancel
deprecated_on: '2026-10-22'
operation: workflows.executions.cancel
- method: POST
path: /automation-flows/interventions/{intervention_id}/approve
replaced_by: workflow_interventions.approve
deprecated_on: '2026-10-22'
operation: workflows.interventions.approve
- method: POST
path: /automation-flows/interventions/{intervention_id}/reject
replaced_by: workflow_interventions.reject
deprecated_on: '2026-10-22'
operation: workflows.interventions.reject
- method: GET
path: /esign/envelopes
replaced_by: signature_requests.list
deprecated_on: '2026-10-22'
operation: signatures.list
- method: GET
path: /esign/envelopes/{envelope_id}
replaced_by: signature_requests.retrieve
deprecated_on: '2026-10-22'
operation: signatures.retrieve
- method: GET
path: /esign/envelopes/{envelope_id}/download
replaced_by: signature_requests.download
deprecated_on: '2026-10-22'
operation: signatures.download
- operation: signature_requests.retrieve_by_external_id
method: GET
path: /esign/envelopes/by-external-id/{external_id}
replaced_by: signature_requests.list
deprecated_on: '2026-10-22'
- method: POST
path: /esign/envelopes
replaced_by: signature_requests.create
deprecated_on: '2026-10-22'
operation: signatures.create
- method: PATCH
path: /esign/envelopes/{envelope_id}
replaced_by: signature_requests.update
deprecated_on: '2026-10-22'
operation: signatures.update
- method: DELETE
path: /esign/envelopes/{envelope_id}
replaced_by: signature_requests.delete
deprecated_on: '2026-10-22'
operation: signatures.delete
- method: PUT
path: /esign/envelopes/{envelope_id}/external-reference
replaced_by: signature_requests.set_external_reference
deprecated_on: '2026-10-22'
operation: signatures.set_external_reference
- method: POST
path: /esign/envelopes/{envelope_id}/documents
replaced_by: signature_requests.documents.add
deprecated_on: '2026-10-22'
operation: signatures.documents.add
- method: DELETE
path: /esign/envelopes/{envelope_id}/documents/{document_key}
replaced_by: signature_requests.documents.remove
deprecated_on: '2026-10-22'
operation: signatures.documents.remove
- method: POST
path: /esign/envelopes/{envelope_id}/documents/{document_key}/refresh
replaced_by: signature_requests.documents.refresh
deprecated_on: '2026-10-22'
operation: signatures.documents.refresh
- method: POST
path: /esign/envelopes/{envelope_id}/documents/{document_key}/signoff
replaced_by: signature_requests.documents.sign_off
deprecated_on: '2026-10-22'
operation: signatures.documents.sign_off
- method: POST
path: /esign/envelopes/{envelope_id}/suggest
replaced_by: signature_requests.suggest_fields
deprecated_on: '2026-10-22'
operation: signatures.suggest_fields
- method: PATCH
path: /esign/envelopes/{envelope_id}/signers/{signer_id}
replaced_by: signature_requests.signers.update
deprecated_on: '2026-10-22'
operation: signatures.signers.update
- method: POST
path: /esign/envelopes/{envelope_id}/send
replaced_by: signature_requests.send
deprecated_on: '2026-10-22'
operation: signatures.send
- method: POST
path: /esign/envelopes/{envelope_id}/remind
replaced_by: signature_requests.remind
deprecated_on: '2026-10-22'
operation: signatures.remind
- method: POST
path: /esign/envelopes/{envelope_id}/void
replaced_by: signature_requests.void
deprecated_on: '2026-10-22'
operation: signatures.void
- method: POST
path: /esign/envelopes/{envelope_id}/rebuild
replaced_by: signature_requests.retry_completion
deprecated_on: '2026-10-22'
operation: signatures.rebuild
- method: GET
path: /intakes/matters/{instance_id}/finance
replaced_by: finance.ledger
deprecated_on: '2026-10-22'
- method: GET
path: /intakes/matters/{instance_id}/finance/export
replaced_by: finance.export
deprecated_on: '2026-10-22'
- method: GET
path: /timesheet/timer
replaced_by: time.timer.retrieve
deprecated_on: '2026-10-22'
# --- truncated at 32 KB (57 KB total) ---
# Full source: https://artifacts.apis.io/lexifina/openapi/lexifina-documents-versions-api-openapi.yml