Top
Content API

Specifying Query Parameters in the GET API

Last updated: 2026/04/27

The following query parameters can be used in the GET API regardless of the schema structure of the corresponding API.

draftKey
limit
offset
q
ids
depth (applies only to content references and multiple content references)
richEditorFormat (applies only to the old rich editor)

On the other hand, the following query parameters have limited applicable fields, and the usage may differ for each field.

orders
fields
filters (equals, not_equals, less_than, greater_than, exists, not_exists, begins_with)

The applicable fields for each query parameter are as follows.

	orders	fields	filters （equals, not_equals）	filters （contains, not_contains）	filters （less_than, greater_than）	filters （exists, not_exists）	filters （begins_with）
Text Field	◯	◯	◯	◯	-	◯	◯
Text Area	◯	◯	◯	◯	-	◯	◯
Rich Editor	-	◯	-	◯	-	◯	◯（※3）
Old Rich Editor (Deprecated)	-	◯	-	◯	-	◯	◯（※3）
Image	-	◯（※1）	-	-	-	◯	-
Multiple Images	-	◯（※1）	-	-	-	◯	-
Date and Time （including automatically granted date and time）	◯	◯	◯	◯	◯	◯	◯（※4）
Boolean	-	◯	◯	-	-	◯（※2）	-
Select Field	-	◯	-	◯	-	◯	-
Content Reference （Field itself）	-	◯	◯	-	-	◯	-
Content Reference （Referenced Field）	-	◯	-	-	-	-	-
Multiple Content Reference （Field itself）	-	◯	-	◯	-	◯	-
Multiple Content Reference （Referenced Field）	-	◯	-	-	-	-	-
Number	◯	◯	◯	-	◯	◯	-
Custom Field （Field itself）	-	◯	-	-	-	-	-
Custom Field （Field within Custom Field）	◯	-	◯	◯	◯	◯	◯
Repeating Field （Field itself）	-	◯	-	-	-	-	-
Repeating Field （Field within Repeating Field）	◯（※5）	-	-	◯	-	◯	◯
File	-	◯（※1）	-	-	-	◯	-
Extended Field （Extended Field itself）	-	◯	-	-	-	-	-
Extended Field （`updatedAt` Metadata）	◯（※6）	-	◯（※6）	◯（※6）	◯（※6）	◯（※6）	◯（※6）
Extended Field （Metadata other than `updatedAt`）	◯（※6）	-	◯（※6）	◯（※6）	-	◯（※6）	◯（※6）

Information

Items marked with "-" may be unsupported or have undefined behavior.
For fields that allow nested structures, such as content references and Custom Fields, specifying various query parameters for the lower-level fields may result in undefined behavior. Please be aware of this in advance.
In "Custom Fields (fields within Custom Fields)" and "Repeating Fields (fields within Repeating Fields)," items marked with "◯" may not be available depending on the field.

Notes

(※1) Keys in images or files (such as url, width, height, etc.) cannot be specified.
(※2) Whether true or false, the content is considered to exist in either case.
(※3) This will be a prefix match for strings excluding HTML tags.
(※4) This is a prefix match for dates, not a specification of the start period.
(※5) When multiple Custom Fields are inserted, the reference values differ for descending and ascending order. For details, please check "Order when specifying fields within a repeat field."
(※6) Only the meta information of extension fields can be specified. For details, please check "Extension Fields."

Contents

Notes