Get workspace/folder

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

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

curl -i -X POST \
  'https://{api_base_url_without_scheme}/rest/v1/spaces' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "parent_space_id": "8ef2f869-ead8-4248-b1b3-7fae1b7be5d7",
    "display_name": "string",
    "description": "string"
  }'

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

curl -i -X GET \
  'https://{api_base_url_without_scheme}/rest/v1/spaces/{space_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

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"
}

Update workspace/folder

Request

Update the workspace/folder

Security

OAuth2ClientCredentials

Path

space_idstring(uuid)required

Workspace/folder ID

Bodyapplication/jsonrequired

Workspace/folder update request

display_namestring[ 1 .. 100 ] charactersrequired

Workspace/folder name

descriptionstring[ 0 .. 100 ] characters

Workspace/folder description

curl -i -X PATCH \
  'https://{api_base_url_without_scheme}/rest/v1/spaces/{space_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "display_name": "string",
    "description": "string"
  }'

Responses

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