Skip to content

Latest commit

 

History

History
59 lines (58 loc) · 6.13 KB

entry-query-params.md

File metadata and controls

59 lines (58 loc) · 6.13 KB

Entry Query Params

Param Accepts Description
addOrderBy `string array
addSelect `string array
after `DateTime string`
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
authorGroup `string string[]
authorGroupId `int int[]
authorId `int int[]
before `DateTime string`
contentTable `string null`
customFields `FieldInterface[] null`
dateCreated mixed When the resulting elements must have been created
dateUpdated mixed When the resulting elements must have been last updated
descendantDist `int null`
descendantOf `int ElementInterface
editable bool Whether to only return entries that the user has permission to edit
elementType `string null`
enabledForSite bool Whether the elements must be enabled for the chosen site
expiryDate mixed The Expiry Date that the resulting entries must have
fixedOrder bool Whether results should be returned in the order specified by id
id `int int[]
indexBy `string callable`
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
postDate mixed The Post Date that the resulting entries must have
prevSiblingOf `int ElementInterface
ref `string string[]
relatedTo `int array
search `string array
section `string string[]
sectionId `int int[]
select array The columns being selected
siblingOf `int ElementInterface
site `string Site`
siteId `int null`
slug `string string[]
status `string string[]
structureId `int false
title `string string[]
type `string string[]
typeId `int int[]
uid `string string[]
uri `string string[]
where `string array`
with `string array