LegalOn API (1.2.0)

API documentation for LegalOn services

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

Delete a matter message

Request

Only the original author can logically delete the specified matter message. Returns 403 for another user and 404 when the message does not exist, belongs to another matter, or has already been deleted.

Security

OAuth2ClientCredentials

Path

matter_idstring(uuid)required

LegalOn-generated matter ID that owns the message.

message_idstring(uuid)required

LegalOn-generated message ID.

curl -i -X DELETE \
  'https://{api_base_url_without_scheme}/rest/v1/matters/{matter_id}/messages/{message_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

No Content

Response

No content

Link existing files to a matter

Request

Links one or more existing files to the specified matter. Upload files with POST /files first. A request can link up to 10 files. The same file can also be linked to a contract with POST /contracts/{document_id}/related-file-links.

Security

OAuth2ClientCredentials

Path

matter_idstring(uuid)required

LegalOn-generated matter ID.

Bodyapplication/jsonrequired

Matter related file link request.

related_file_idsArray of strings(uuid)[ 1 .. 10 ] itemsrequired

Existing related file IDs to link to the matter.

curl -i -X POST \
  'https://{api_base_url_without_scheme}/rest/v1/matters/{matter_id}/related-file-links' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "related_file_ids": [
      "00000000-0000-0000-0000-000000000040"
    ]
  }'

Responses

No Content

Response

No content

List files related to a matter

Request

Retrieves files related to the specified matter.

Security

OAuth2ClientCredentials

Path

matter_idstring(uuid)required

LegalOn-generated matter ID.

curl -i -X GET \
  'https://{api_base_url_without_scheme}/rest/v1/matters/{matter_id}/related-files' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

filesArray of objects(MatterRelatedFile)required

Files related to the matter.

files[].file_idstring(uuid)required

LegalOn-generated file ID.

files[].file_namestringnon-emptyrequired

File name.

files[].mime_typestringnon-empty

File MIME type. Omitted when the stored file metadata does not contain a MIME type.

files[].created_atstring(date-time)required

File creation time.

Response

application/json

{
  "files": [
    { … }
  ]
}

Files

Operations to create files for use by LegalOn resources.

Operations

Workspaces

Workspaces/folders are the common units used to store and organize resources such as contracts. This endpoint returns the workspaces/folders the calling user has access to, as a tree. For operations that target a workspace (e.g., the Contract API), specify the workspace_id obtained here. To manage workspaces across the tenant (creation, permissions, etc.), see the admin workspace operations (/spaces).

Operations