A comma separated list of fields to include in the response. When including this property, only the explicitly requested entry properties will be included in the response.
_labels
integer
no
Default is 0. Indicates whether to enable the inclusion of field labels in the results.
form_ids
array
no
An array of forms for which entries should be included.
include
array
no
An array of entries to include in the response. If an included entry id is not found in the database, no error is thrown.
search
array
no
An associative array containing the search arguments. It is expected that search will be provided as JSON.
sorting
array
no
An associative array containing the sorting arguments.
paging
null|array
no
An associative array containing the paging arguments. Use paging to limit the number of entries.
Search arguments
Parameter
Type
Required
Description
status
string
no
Default is active. The status of the entry. Possible values are active, spam, trash.
field_filters
array
no
One or more associative arrays. See Field Filter. You can also se the mode parameter. Defaults to all. Possible values: all or any. Determines if the found entries have to match all the field filters or any.
Field filter
Parameter
Type
Required
Description
key
string
yes
The field ID, entry property, or entry meta key.
value
string | integer | float | array
yes
The value to find for the specified key.
operator
string
no
Defaults to “=”. Possible values: =, IS, CONTAINS, IS NOT, ISNOT, <>, LIKE, NOT IN, NOTIN, or IN. Lowercase is also supported.
is_numeric
boolean
no
Indicates if the values of the specified key are numeric.
Sorting arguments
Parameter
Type
Required
Description
key
string | integer
no
Default is entry id. The database field by which to sort. Possible values: id, form_id, post_id, date_created, date_updated, is_starred, is_read, ip, source_url, user_agent, currency, payment_status, payment_date, payment_amount, payment_method, transaction_id, is_fulfilled, created_by, transaction_type, status, source_id
direction
string
no
Default is DESC. The direction of sorting. Either ASC, DESC, or RAND (random order).
is_numeric
boolean
no
Default is false when sorting[key] is specified. Indicates if the key is numeric.
Paging arguments
Parameter
Type
Required
Description
page_size
integer
no
The number of results per page.
current_page
integer
no
The current page from which to pull details.
offset
integer
no
The record number on which to start retrieving data. It is zero-based. If the current_page property is specified, then offset is not used.
Response
A successful response will contain a JSON object with matching entries.