Skip to main content
GET
Error

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

​
documentListName
string
required

Query Parameters

​
filter
string

Mozu.Content.Contracts.PropertyType filter expression to match against document properties.

​
sortBy
string

Sort expression.

​
pageSize
integer<int32>

Page size

​
startIndex
integer<int32>

First item in the page to return from the total result set

​
includeInactive
boolean

if this call should include a adocument that isn't active in the given preview date

​
path
string

path from which to return documents

​
includeSubPaths
boolean
default:false

if true this call will populate Subpaths

​
queryScope
string
default:SpecifiedPathOnly

Determines if the path parameter is used to scope the query to the specified path or ignored for a global scope. Defaults to specified path only. Valid values are: SpecifiedPathOnly, Global

​
fullSearch
boolean
default:false

When {true}, performs an exhaustive search guaranteeing all matching documents are returned. Slower than the default on large lists. Returns HTTP 400 if the document list exceeds the configured maximum size threshold (default 100,000). Defaults to {false}, optimizing for speed.

​
responseFields
string

limits which fields are returned in the response body

Response

Success

​
items
object[] | null
​
pageCount
integer<int32>
​
pageSize
integer<int32>
​
startIndex
integer<int32>
​
subPaths
string[] | null
​
totalCount
integer<int32>