Skip to content

LegalOn API (0.9.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

List users

Request

Retrieve a list of users

Security
OAuth2ClientCredentials
Query
page_tokenstring

Token for getting the previous/next page

page_sizeinteger>= 1required

The number of results to retrieve per page

search_querystringnon-empty

Username or email address search query (partial match)

user_statusesArray of strings

User status to filter (OR condition when multiple are specified)

Items Enum"INVITED""ACTIVE""INACTIVE"
roleArray of strings

User roles to filter (OR condition when multiple are specified)

Responses

OK

Bodyapplication/json
usersArray of objects(user)required
users[].​user_idstring(uuid)required

User Id

users[].​emailstring(email)required

User email address

users[].​user_statusstringrequired

User status

Enum"INVITED""ACTIVE""INACTIVE"
users[].​display_namestring[ 1 .. 48 ] charactersrequired

User name

users[].​profile_image_urlstring(uri)

Profile image URL

users[].​user_rolesArray of stringsrequired

User roles Available roles vary by region

JP Region

  • ItAdmin (IT Admin)
  • MatterManagementPro (Matter Management: Pro)
  • MatterManagementStandard (Matter Management: Standard)
  • MatterManagementAdmin (Matter Management: Admin)
  • ReviewStandard (Review: Standard)
  • ReviewStandardPlaybook (Review: Standard (Playbook))
  • ReviewPro (Review: Pro)
  • ReviewBasicPlaybook (Review: Basic (Playbook))
  • ReviewAdmin (Review: Admin)
  • SignUser (Sign: User)
  • SignAdmin (Sign: Admin)
  • ContractManagementAdmin (Contract Management: Admin)
  • LegalonTemplatePro (Legalon Template: Pro)
  • LegalonTemplateAdmin (Legalon Template: Admin)
  • MoriHamadaLibraryPro (Mori Hamada Library: Pro)
  • MoriHamadaLibraryAdmin (Mori Hamada Library: Admin)
  • UniversalAssistStandard (Universal Assist: Standard)
  • UniversalAssistAdmin (Universal Assist: Admin)
  • LegalonAssistantPro (Legalon Assistant: Pro)
  • LegalonAssistantStandard (Legalon Assistant: Standard)
  • LegalonAssistantAdmin (Legalon Assistant: Admin)

US Region

  • ItAdmin (IT Admin)
  • USMatterManagementPro (Matter Management: Pro)
  • MatterManagementStandard (Matter Management: Standard)
  • MatterManagementAdmin (Matter Management: Admin)
  • USReviewPro (Review: Pro)
  • USReviewAdmin (Review: Admin)
  • ContractManagementAdmin (Contract Management: Admin)
  • USLegalonAssistantPro (Legalon Assistant: Pro)
  • LegalonAssistantStandard (Legalon Assistant: Standard)
  • LegalonAssistantAdmin (Legalon Assistant: Admin)
  • TranslationPro (Translation: Pro)
  • TranslationAdmin (Translation: Admin)
next_page_tokenstring

Token to get the next page (omitted if page does not exist)

prev_page_tokenstring

Token to get the prev page (omitted if page does not exist)

total_sizeinteger>= 0required

Total number of matches for the search criteria

Response
application/json
{
  "users": [
    { … }
  ],
  "total_size": 150,
  "next_page_token": "eyJvZmZz...",
  "prev_page_token": "eyJvZmZz..."
}

Create user

Request

Create a new user

Security
OAuth2ClientCredentials
Bodyapplication/jsonrequired

User creation request

display_namestring[ 1 .. 48 ] charactersrequired

User name

emailstring(email)required

User email address

user_rolesArray of stringsrequired

User roles

Responses

Created

Bodyapplication/json
user_idstring(uuid)required

User Id

emailstring(email)required

User email address

user_statusstringrequired

User status

Enum"INVITED""ACTIVE""INACTIVE"
display_namestring[ 1 .. 48 ] charactersrequired

User name

profile_image_urlstring(uri)

Profile image URL

user_rolesArray of stringsrequired

User roles Available roles vary by region

JP Region

  • ItAdmin (IT Admin)
  • MatterManagementPro (Matter Management: Pro)
  • MatterManagementStandard (Matter Management: Standard)
  • MatterManagementAdmin (Matter Management: Admin)
  • ReviewStandard (Review: Standard)
  • ReviewStandardPlaybook (Review: Standard (Playbook))
  • ReviewPro (Review: Pro)
  • ReviewBasicPlaybook (Review: Basic (Playbook))
  • ReviewAdmin (Review: Admin)
  • SignUser (Sign: User)
  • SignAdmin (Sign: Admin)
  • ContractManagementAdmin (Contract Management: Admin)
  • LegalonTemplatePro (Legalon Template: Pro)
  • LegalonTemplateAdmin (Legalon Template: Admin)
  • MoriHamadaLibraryPro (Mori Hamada Library: Pro)
  • MoriHamadaLibraryAdmin (Mori Hamada Library: Admin)
  • UniversalAssistStandard (Universal Assist: Standard)
  • UniversalAssistAdmin (Universal Assist: Admin)
  • LegalonAssistantPro (Legalon Assistant: Pro)
  • LegalonAssistantStandard (Legalon Assistant: Standard)
  • LegalonAssistantAdmin (Legalon Assistant: Admin)

US Region

  • ItAdmin (IT Admin)
  • USMatterManagementPro (Matter Management: Pro)
  • MatterManagementStandard (Matter Management: Standard)
  • MatterManagementAdmin (Matter Management: Admin)
  • USReviewPro (Review: Pro)
  • USReviewAdmin (Review: Admin)
  • ContractManagementAdmin (Contract Management: Admin)
  • USLegalonAssistantPro (Legalon Assistant: Pro)
  • LegalonAssistantStandard (Legalon Assistant: Standard)
  • LegalonAssistantAdmin (Legalon Assistant: Admin)
  • TranslationPro (Translation: Pro)
  • TranslationAdmin (Translation: Admin)
Response
application/json
{
  "user_id": "76088fa5-1ce5-3ca9-303a-8466c48581ba",
  "email": "user@example.com",
  "user_status": "ACTIVE",
  "display_name": "Legal Taro",
  "profile_image_url": "https://...",
  "user_roles": [
    "ItAdmin"
  ]
}

Get user

Request

Retrieve the user

Security
OAuth2ClientCredentials
Path
user_idstring(uuid)required

User ID

Responses

OK

Bodyapplication/json
user_idstring(uuid)required

User Id

emailstring(email)required

User email address

user_statusstringrequired

User status

Enum"INVITED""ACTIVE""INACTIVE"
display_namestring[ 1 .. 48 ] charactersrequired

User name

profile_image_urlstring(uri)

Profile image URL

user_rolesArray of stringsrequired

User roles Available roles vary by region

JP Region

  • ItAdmin (IT Admin)
  • MatterManagementPro (Matter Management: Pro)
  • MatterManagementStandard (Matter Management: Standard)
  • MatterManagementAdmin (Matter Management: Admin)
  • ReviewStandard (Review: Standard)
  • ReviewStandardPlaybook (Review: Standard (Playbook))
  • ReviewPro (Review: Pro)
  • ReviewBasicPlaybook (Review: Basic (Playbook))
  • ReviewAdmin (Review: Admin)
  • SignUser (Sign: User)
  • SignAdmin (Sign: Admin)
  • ContractManagementAdmin (Contract Management: Admin)
  • LegalonTemplatePro (Legalon Template: Pro)
  • LegalonTemplateAdmin (Legalon Template: Admin)
  • MoriHamadaLibraryPro (Mori Hamada Library: Pro)
  • MoriHamadaLibraryAdmin (Mori Hamada Library: Admin)
  • UniversalAssistStandard (Universal Assist: Standard)
  • UniversalAssistAdmin (Universal Assist: Admin)
  • LegalonAssistantPro (Legalon Assistant: Pro)
  • LegalonAssistantStandard (Legalon Assistant: Standard)
  • LegalonAssistantAdmin (Legalon Assistant: Admin)

US Region

  • ItAdmin (IT Admin)
  • USMatterManagementPro (Matter Management: Pro)
  • MatterManagementStandard (Matter Management: Standard)
  • MatterManagementAdmin (Matter Management: Admin)
  • USReviewPro (Review: Pro)
  • USReviewAdmin (Review: Admin)
  • ContractManagementAdmin (Contract Management: Admin)
  • USLegalonAssistantPro (Legalon Assistant: Pro)
  • LegalonAssistantStandard (Legalon Assistant: Standard)
  • LegalonAssistantAdmin (Legalon Assistant: Admin)
  • TranslationPro (Translation: Pro)
  • TranslationAdmin (Translation: Admin)
Response
application/json
{
  "user_id": "76088fa5-1ce5-3ca9-303a-8466c48581ba",
  "email": "user@example.com",
  "user_status": "ACTIVE",
  "display_name": "Legal Taro",
  "profile_image_url": "https://...",
  "user_roles": [
    "ItAdmin"
  ]
}

User Groups

Operations about user group

Operations

Workspaces

Operations about workspace/folder

Operations

Departments

Operations about department

Operations