Get list of public folders

GET

/domains/{domainID}/folders

curl --request GET \
  --url 'https://example.com/api/v1/domains/1/folders?offset=0&limit=50&parentID=144115188075855870' \
  --cookie grommunioAuthJwt=<grommunioAuthJwt>

• Default deployment path

Authorizations

• JWTCookie

Parameters

Path Parameters

domainID

required

integer

ID of the domain

Query Parameters

offset

integer

0

Index of the first element to return

limit

integer

default: 50

Maximum number of results to return

match

string

Match by substring

parentID

integer

default: 144115188075855870

ID of the parent folder

Responses

200

List of public folders returned

Media typeapplication/json

object

data

Array<object>

object

folderid

string

displayname

string

comment

string

creationtime

Date string with time

string

nullable /^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/

container

string

syncToMobile

boolean

Example^generated

{
  "data": [
    {
      "folderid": "example",
      "displayname": "example",
      "comment": "example",
      "creationtime": "example",
      "container": "example",
      "syncToMobile": true
    }
  ]
}

400

Validation of input parameters failed

Media typeapplication/json

object

message

string

errors

List of errors encountered during validation

Array<string>

Example^generated

{
  "message": "example",
  "errors": [
    "example"
  ]
}

404

The requested resource could not be found

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

500

An error occurred while processing the request

Media typeapplication/json

object

message

String representation of the exception

string

Example^generated

{
  "message": "example"
}

503

The database query failed

Media typeapplication/json

object

message

Description of the error

string

Example^generated

{
  "message": "example"
}