Skip to content

LegalOn API (1.3.1)

API documentation for LegalOn services

Languages
Servers
The server URL is `{api_base_url}/rest/v1`. You can construct the server URL using the value of `api_base_url` provided in the response when obtaining an access token.
https://{api_base_url_without_scheme}/rest/v1

Users

Operations about user

Operations

User Groups

Operations about user group

Operations

Workspaces

Operations about all tenant workspaces/folders regardless of the user's access permissions.

Operations

Departments

Operations about department

Operations

Contracts(Files)

Operations to create, retrieve, update, and delete contracts. For operations that target a workspace, specify a workspace_id obtained via the common Workspaces endpoint (GET /workspaces).

Operations

Matters

Operations to create, retrieve, update, and delete matters. Matter operations require an API credential owned by a user with a Matter Management Pro license.

Operations

Files

Operations to create and manage files for LegalOn resources.

Operations

Delete a file

Request

Deletes the specified file, including when it is referenced by another resource.

Security
OAuth2ClientCredentials
Path
file_idstring(uuid)required

File ID

curl -i -X DELETE \
  'https://{api_base_url_without_scheme}/rest/v1/files/{file_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Deleted

Response
No content

Get a file download URL

Request

Overview

Returns a short-lived signed URL for the requested file.

Processing notes

  • If file_version_id is omitted, the latest version is used.
  • The URL is a bearer credential; use it promptly and do not log or share it.
  • The API does not return a guaranteed expiration time.
Security
OAuth2ClientCredentials
Path
file_idstring(uuid)required

File ID

Query
file_version_idstring(uuid)

File version ID. If omitted, the latest version is used.

curl -i -X GET \
  'https://{api_base_url_without_scheme}/rest/v1/files/{file_id}:download?file_version_id=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
file_namestringrequired

File name of the requested version, including its extension. Use this name when saving the downloaded content.

Example: "contract.docx"
urlstring(uri)required

Signed download URL.

  • Do not log or share this value.
Example: "https://storage.example.com/signed-download-url"
Response
application/json
{ "file_name": "contract.docx", "url": "https://storage.example.com/signed-download-url" }

Workspaces

Workspaces/folders are the common units used to store and organize resources such as contracts.

Operations