In the GET API, the following query parameters can be used regardless of the schema structure of the corresponding API.
draftKeylimitoffsetqidsdepth (applies only to Content Reference and Multiple Content References)richEditorFormat (applies only to Old Rich Text Editor)On the other hand, the following query parameters are limited to specific fields, and the usage may differ for each field.
ordersfieldsfilters (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 | filters | filters | filters | filters | |
|---|---|---|---|---|---|---|---|
Text Field | ◯ | ◯ | ◯ | ◯ | - | ◯ | ◯ |
Text Area | ◯ | ◯ | ◯ | ◯ | - | ◯ | ◯ |
Rich Editor | - | ◯ | - | ◯ | - | ◯ | ◯（※3） |
Old Rich Editor (Deprecated) | - | ◯ | - | ◯ | - | ◯ | ◯（※3） |
Image | - | ◯（※1） | - | - | - | ◯ | - |
Multiple Images | - | ◯（※1） | - | - | - | ◯ | - |
Date and Time | ◯ | ◯ | ◯ | ◯ | ◯ | ◯ | ◯（※4） |
Boolean | - | ◯ | ◯ | - | - | ◯（※2） | - |
Select Field | - | ◯ | - | ◯ | - | ◯ | - |
Content Reference | - | ◯ | ◯ | - | - | ◯ | - |
Content Reference | - | ◯ | - | - | - | - | - |
Multiple Content Reference | - | ◯ | - | ◯ | - | ◯ | - |
Multiple Content Reference | - | ◯ | - | - | - | - | - |
Number | ◯ | ◯ | ◯ | - | ◯ | ◯ | - |
Custom Field | - | ◯ | - | - | - | - | - |
Custom Field | ◯ | - | ◯ | ◯ | ◯ | ◯ | ◯ |
Repeating Field | - | ◯ | - | - | - | - | - |
Repeating Field | ◯（※5） | - | - | ◯ | - | ◯ | ◯ |
File | - | ◯（※1） | - | - | - | ◯ | - |
Extended Field | - | ◯ | - | - | - | - | - |
Extended Field | ◯（※6） | - | ◯（※6） | ◯（※6） | ◯（※6） | ◯（※6） | ◯（※6） |
Extended Field | ◯（※6） | - | ◯（※6） | ◯（※6） | - | ◯（※6） | ◯（※6） |
(※1) Keys within images or files (such as url, width, height, etc.) cannot be specified.
(※2) In both cases of true or false, the content is considered to exist.
(※3) This will match the beginning of the string, excluding HTML tags.
(※4) This is a prefix match for the date, 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 refer to "Order when specifying fields within repeat fields."
(※6) Only the meta information of extended fields can be specified. For details, please refer to "Extended Fields."