Get a list of directories — Request

Methods

  • POST — Get a list of directories
  • GET — Get a list of directories

Resource

{
    "active": "boolean",
    "filter": {
        "<key>": {}
    },
    "from": "int64",
    "ids": [
        "uuid"
    ],
    "size": "int64",
    "sortExpressions": [
        {
            "ascending": "boolean",
            "field": "string"
        }
    ]
}

Properties

Name Type Description Additional
active boolean

Show active only (not deleted)

 Optional
filter object

Filtering

 Optional
filter.<key> map of object Optional
from int64

Return starting from item

 Optional
ids[] array of uuid

Filter by ID

 Optional
size int64

Number of returned items (10000 max)

 Optional
sortExpressions[] array

Sorting rules

 Optional
sortExpressions[].ascending boolean

Ascending sorting order flag

 Optional
sortExpressions[].field string

Sort field

 Optional