Skip to main content
GET
/
content
/
documentlists
/
{documentListName}
/
documents
Error
A valid request URL is required to generate request examples
{
  "subPaths": [
    "<string>"
  ],
  "startIndex": 123,
  "pageSize": 123,
  "pageCount": 123,
  "totalCount": 123,
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "path": "<string>",
      "publishSetCode": "<string>",
      "extension": "<string>",
      "documentTypeFQN": "<string>",
      "listFQN": "<string>",
      "contentLength": 123,
      "contentMimeType": "<string>",
      "contentUpdateDate": "2023-11-07T05:31:56Z",
      "publishState": "<string>",
      "properties": "<unknown>",
      "insertDate": "2023-11-07T05:31:56Z",
      "updateDate": "2023-11-07T05:31:56Z",
      "activeDateRange": {
        "startDate": "2023-11-07T05:31:56Z",
        "endDate": "2023-11-07T05:31:56Z"
      }
    }
  ]
}

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

​
responseFields
string

limits which fields are returned in the response body

Response

Success

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