Skip to content

Latest commit

 

History

History
60 lines (59 loc) · 6.16 KB

asset-query-params.md

File metadata and controls

60 lines (59 loc) · 6.16 KB

Asset Query Params

Param Accepts Description
addOrderBy `string array
addSelect `string array
ancestorDist `int null`
ancestorOf `int ElementInterface
andWhere `string array`
archived bool Whether to return only archived elements
asArray bool Whether to return each element as an array
contentTable `string null`
customFields `FieldInterface[] null`
dateCreated mixed When the resulting elements must have been created
dateModified mixed The Date Modified that the resulting assets must have
dateUpdated mixed When the resulting elements must have been last updated
descendantDist `int null`
descendantOf `int ElementInterface
elementType `string null`
enabledForSite bool Whether the elements must be enabled for the chosen site
filename `string string[]
fixedOrder bool Whether results should be returned in the order specified by id
folderId `int int[]
height `int null`
id `int int[]
includeSubfolders bool Whether the query should search the subfolders of folderId
indexBy `string callable`
kind `string string[]
level `int null`
limit integer Maximum number of records to be returned
nextSiblingOf `int ElementInterface
offset integer Zero-based offset from where the records are to be returned
orWhere `string array`
orderBy array How to sort the query results
positionedAfter `int ElementInterface
positionedBefore `int ElementInterface
prevSiblingOf `int ElementInterface
ref `string string[]
relatedTo `int array
search `string array
select array The columns being selected
siblingOf `int ElementInterface
site `string Site`
siteId `int null`
size `int null`
slug `string string[]
source `string string[]
sourceId `int int[]`
status `string string[]
structureId `int false
title `string string[]
uid `string string[]
uri `string string[]
volume `string string[]
volumeId `int int[]
where `string array`
width `int null`
with `string array
withTransforms `array null`