Get a page of documents in a specific folder

get/documents
SecuritybearerAuth
Request
query Parameters
page
required
integer <int32> (PageParam) >= 1

Page of results to show

Example: page=1
pageSize
required
integer <int32> (ResultsPerPageParam) [ 1 .. 1000 ]

Results to return per page

Example: pageSize=100
sort
string (SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fields
string (FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
level
required
string (DocumentLevel)

Filter by document level, e.g. CUSTOMER

Value: "CUSTOMER"
levelId
required
string (IdFilterParam)

Filter by level id, e.g. customer id 1234

Example: levelId=0
parentDocumentId
string (IdFilterParam)

Filter by folder id, e.g. folder ABC with id 456, omitting this implies the root folder

Example: parentDocumentId=0
tags
string (StringFilterParam)

Filter by tag name

Example: tags=xyz | in:x,y | like:xyz
name
string (StringFilterParam)

Filter by document name

Example: name=xyz | in:x,y | like:xyz
recursive
string (BooleanFilterParam)

Search all sub-folders below the folder level specified

Example: recursive=true | false
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

Response samples
application/json
[
  • {
    • "id": 1,
    • "parentDocumentId": 1,
    • "levelId": 1,
    • "level": "CUSTOMER",
    • "type": "FILE",
    • "name": "/helloworld.doc",
    • "owner": "Tommy Tynan",
    • "ownerUserId": 1,
    • "sizeInKb": 1,
    • "path": "/folder1/folder2/",
    • "uploadDateTime": "2019-08-24T14:15:22Z",
    • "tags": [
      • {
        • "name": "string"
        }
      ]
    }
]