Skip to content
/
Create workspace/folder

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

User Groups

Operations about user group

Operations

Workspaces

Operations about workspace/folder

Operations

List workspaces/folders

Request

Retrieve a list of workspaces/folders

Security
OAuth2ClientCredentials
Query
parent_space_idstring(uuid)

Parent workspace/folder ID. If not specified, all workspaces/folders list will be listed.

Responses

OK

Bodyapplication/json
spacesArray of objects(space)required
spaces[].​space_idstring(uuid)required

Space Id

spaces[].​display_namestring[ 1 .. 100 ] charactersrequired

Space name

spaces[].​descriptionstring[ 0 .. 100 ] characters

Space description

total_sizeinteger>= 0required

Total number of matches for the search criteria

Response
application/json
{
  "spaces": [
    { … }
  ],
  "total_size": 150
}

Create workspace/folder

Request

Create a new workspace/folder

Security
OAuth2ClientCredentials
Bodyapplication/jsonrequired

Workspace/folder creation request

parent_space_idstring(uuid)

Parent workspace/folder ID

display_namestring[ 1 .. 100 ] charactersrequired

Workspace/folder name

descriptionstring[ 0 .. 100 ] characters

Workspace/folder description

Responses

Created

Bodyapplication/json
space_idstring(uuid)required

Space Id

display_namestring[ 1 .. 100 ] charactersrequired

Space name

descriptionstring[ 0 .. 100 ] characters

Space description

Response
application/json
{
  "space_id": "76088fa5-1ce5-3ca9-303a-8466c48581ba",
  "display_name": "Legal Department Space",
  "description": "Contract Review Space"
}

Get workspace/folder

Request

Retrieve the workspace/folder

Security
OAuth2ClientCredentials
Path
space_idstring(uuid)required

Workspace/folder ID

Responses

OK

Bodyapplication/json
space_idstring(uuid)required

Space Id

display_namestring[ 1 .. 100 ] charactersrequired

Space name

descriptionstring[ 0 .. 100 ] characters

Space description

Response
application/json
{
  "space_id": "76088fa5-1ce5-3ca9-303a-8466c48581ba",
  "display_name": "Legal Department Space",
  "description": "Contract Review Space"
}

Departments

Operations about department

Operations