Searching and Getting Entries with the GFAPI

public static function entry_exists( $entry_id ) {}

$result = GFAPI::entry_exists( $entry_id );

public static function get_entry( $entry_id ) {}

$result = GFAPI::get_entry( $entry_id );

public static function get_entries( $form_ids, $search_criteria = array(), $sorting = null, $paging = null, &$total_count = null ) {}

public static function get_entry_ids( $form_ids, $search_criteria = array(), $sorting = null, $paging = null, &$total_count = null ) {}

// Getting the entries
$result = GFAPI::get_entries( $form_id );
// Getting just the IDs
$result = GFAPI::get_entry_ids( $form_id );

$search_criteria = array(
    'status'        => 'active',
    'field_filters' => array(
        'mode' => 'any',
        array(
            'key'   => '1',
            'value' => 'Second Choice'
        ),
        array(
            'key'   => '5',
            'value' => 'My text'
        )
    )
);

// Getting the entries
$result = GFAPI::get_entries( $form_id, $search_criteria );
// Getting just the IDs
$result = GFAPI::get_entry_ids( $form_id, $search_criteria );

$search_criteria = array();
$sorting         = array( 'key' => '5', 'direction' => 'ASC' );
$results         = GFAPI::get_entries( $form_id, $search_criteria, $sorting );

$search_criteria = array();
$sorting         = array();
$paging          = array( 'offset' => 0, 'page_size' => 25 );
$results         = GFAPI::get_entries( $form_id, $search_criteria, $sorting, $paging );

$search_criteria = array();
$sorting         = array();
$paging          = array( 'offset' => 0, 'page_size' => 25 );
$total_count     = 0;
$results         = GFAPI::get_entries( $form_id, $search_criteria, $sorting, $paging, $total_count );

$search_criteria               = array();
$form_id                       = 4;
$start_date                    = date( 'Y-m-d', strtotime('-30 days') );
$end_date                      = date( 'Y-m-d', time() );
$search_criteria['start_date'] = $start_date;
$search_criteria['end_date']   = $end_date;
 
$results = GFAPI::get_entries( $form_id, $search_criteria );

public static function count_entries( $form_ids, $search_criteria = array() ) {}

$result = GFAPI::count_entries( $form_ids, $search_criteria );

$search_criteria = array();

// Filtering by status.
$search_criteria['status'] = 'active';

// Filtering by entry properties, meta, and/or field values.
$search_criteria['field_filters'] = array();

// Filtering by date range.
$search_criteria['start_date'] = $start_date;
$search_criteria['end_date'] = $end_date;

$search_criteria['field_filters'] = array();

// Filtering by entry properties, meta, and/or field values.
$search_criteria['field_filters'][] = $filter;

// Changing the mode.
$search_criteria['field_filters']['mode'] = 'any';

// Filtering by entry properties.
$search_criteria['field_filters'][] = array( 'key' => 'currency', 'value' => 'USD' );
$search_criteria['field_filters'][] = array( 'key' => 'is_read', 'value' => true );
​$search_criteria['field_filters'][] = array( 'key' => 'created_by', 'value' => get_current_user_id() );

// Filtering by field values.
$search_criteria['field_filters'][] = array( 'key' => '1', 'value' => 'gquiz159982170' );

// Supported operators for scalar values: is/=, isnot, contains.
$search_criteria['field_filters'][] = array( 'key' => '1', 'operator' => 'contains', 'value' => 'Steve' );

// Supported operators for array values: in/=, not in/!=
$search_criteria['field_filters'][] = array( 'key' => '1', 'operator' => 'not in', 'value' => array( 'Alex', 'David', 'Dana' ) );

// Filter by a checkbox value (not recommended).
$search_criteria['field_filters'][] = array( 'key' => '2.2', 'value' => 'gquiz246fec995' );
// Notes
// Using input IDs as search keys will work for checkboxes but it won't work if the checkboxes have been re-ordered since the first submission.
// The 'not in' operator is not currently supported for checkbox values.

// Filter by a checkbox value (recommended).
$search_criteria['field_filters'][] = array( 'key' => '2', 'value' => 'gquiz246fec995' );
$search_criteria['field_filters'][] = array( 'key' => '2', 'operator' => 'in', 'value' => array( 'First Choice', 'Third Choice' ) );
// Note
// Neither 'not in' nor '' operators are not currently supported for checkboxes using field IDs as search keys.

// Filter by a global/free-form search of values of any form field.
$search_criteria['field_filters'][] = array( 'value' => $search_value );
// OR
$search_criteria['field_filters'][] = array( 'key' => 0, 'value' => $search_value );

// Filter entries by Entry meta (added using the gform_entry_meta hook).
$search_criteria['field_filters'][] = array( 'key' => 'gquiz_score', 'value' => '1' );
$search_criteria['field_filters'][] = array( 'key' => 'gquiz_is_pass', 'value' => '1' );

$sorting = array( 'key' => $sort_field, 'direction' => 'ASC', 'is_numeric' => true );

$paging = array( 'offset' => 0, 'page_size' => 30 );