Skip to content
Legaldoc.ioLegaldoc.ioLegaldoc.io

Find folders

GET
/folder
curl --request GET \
  --url 'https://app.legaldoc.com/api/v2/folder?type=DOCUMENT' \
  --header 'Authorization: <Authorization>'

Find folders based on a search criteria

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
query
string

The search query.

page
number
>= 1

The pagination page number, starts at 1.

perPage
number
>= 1 <= 100

The number of items per page.

parentId
string
type
string
Allowed values: DOCUMENT TEMPLATE

Responses

Section titled “Responses”

200

Section titled “200”

Successful response

Media typeapplication/json
object
data
required
Array<object>
object
id
required
string
name
required
string
userId
required
number
teamId
required
number
parentId
required
string | null
pinned
required
boolean
createdAt
required
string
updatedAt
required
string
visibility
required
string
Allowed values: EVERYONE MANAGER_AND_ABOVE ADMIN
type
required
string
Allowed values: DOCUMENT TEMPLATE
count
required
number
currentPage
required
number
perPage
required
number
totalPages
required
number
Example
{
  "data": [
    {
      "visibility": "EVERYONE",
      "type": "DOCUMENT"
    }
  ]
}

400

Section titled “400”

Invalid input data

Media typeapplication/json
object
message
required
string
code
required
string
issues
Array<object>
object
message
required
string
Examplegenerated
{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}

401

Section titled “401”

Authorization not provided

Media typeapplication/json
object
message
required
string
code
required
string
issues
Array<object>
object
message
required
string
Examplegenerated
{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}

403

Section titled “403”

Insufficient access

Media typeapplication/json
object
message
required
string
code
required
string
issues
Array<object>
object
message
required
string
Examplegenerated
{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}

404

Section titled “404”

Not found

Media typeapplication/json
object
message
required
string
code
required
string
issues
Array<object>
object
message
required
string
Examplegenerated
{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}

500

Section titled “500”

Internal server error

Media typeapplication/json
object
message
required
string
code
required
string
issues
Array<object>
object
message
required
string
Examplegenerated
{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}