infoodle

Search form entries with filtering criteria

POST /formentries/search/{fromthisid}
O auth2

Search form entries based on various criteria. Only form entries that the authenticated user has permission to view are included. Supports filtering by form_id, entry_status, user_id, date ranges, and other fields.

Path parameters

  • fromthisid integer Required

    The ID that is previous to the one to start from e.g. if IDs are 1,2,3 fromthisid as 1 will return 2,3

application/json

Body Required

  • search array[object]

    Array of search criteria objects

    Hide search attributes Show search attributes object
    • by string

      The field name to search by

      Values are form_id, entry_status, user_id, date_time_entered_utc, approved_datetime_utc, paid_in_full, total_required, total_paid, event_id, or event_instance.

    • value string | integer

      The value to search for

      One of:
      string-1 string integer-2 integer
    • type string

      The type of comparison to perform

      Values are equal, greater, less, or like. Default value is equal.

Responses

  • 200 application/json

    Search results returned OK

    Hide response attributes Show response attributes object
    • id integer

      The unique form entry ID

    • form_id integer

      The ID of the form this entry belongs to

    • date_time_entered_utc string(date-time)

      The date and time this entry was submitted in UTC

    • entry_status integer

      The status of the form entry -1: Deleted 0: Pending approval 2: Approved

    • user_id integer

      The ID of the user who was linked to this entry (when entry_status is 2)

    • approved_by integer

      The ID of the user who approved this entry

    • approved_datetime_utc string(date-time)

      The date and time this entry was approved in UTC

    • paid_in_full integer

      Whether the payment for this entry is paid in full (1) or not (0)

      Values are 0 or 1.

    • total_required string

      The total amount required for this form entry

    • total_paid string

      The total amount paid for this form entry

    • presented_id integer

      The ID of the presented record associated with this entry

    • reconciled_presented_id integer

      The ID of the reconciled presented record

    • invoice_number string

      The invoice number for this form entry

    • invoice_public_url string

      The public URL to access the invoice

    • payment_fees string

      The fees associated with payment processing

    • nett_of_fees string

      The net amount after deducting fees

    • spam_score string

      The spam score assigned to this entry

    • spam_message string

      Any spam-related message for this entry

    • client_ipaddress string

      The IP address of the client who submitted this entry

    • validation_messages string

      Any validation messages associated with this entry

    • event_id integer

      The ID of the event associated with this form entry

    • event_instance string

      The event instance identifier
  • 400 application/json

    One or more errors have occurred

    Hide response attributes Show response attributes object
    • error string Deprecated

      A single error text or code

    • errors object

      An array of fields and the errors for each field

      Hide errors attribute Show errors attribute object
      • errorfield array[object]

        errorfield is the name of the field that is in error

        Hide errorfield attributes Show errorfield attributes object
        • code integer

          the specific error code for this error

        • message string

          the error message for this error
  • 401 application/json

    Authentication unauthorised

    Hide response attribute Show response attribute object
    • error string
  • 403 application/json

    Invalid permission

    Hide response attribute Show response attribute object
    • error string
POST /formentries/search/{fromthisid} 
curl \
 --request POST 'https://YOURSITE.infoodle.com/apiv2/formentries/search/4' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"search":[{"by":"form_id","value":67},{"by":"entry_status","type":"greater","value":2}]}'
Request examples 
{
  "search": [
    {
      "by": "form_id",
      "value": 67
    },
    {
      "by": "entry_status",
      "type": "greater",
      "value": 2
    }
  ]
}
Response examples (200) 
[
  {
    "id": 12345,
    "form_id": 67,
    "date_time_entered_utc": "2023-10-15T14:30:00Z",
    "entry_status": 2,
    "user_id": 42,
    "approved_by": 42,
    "approved_datetime_utc": "2023-10-16T09:15:00Z",
    "paid_in_full": 1,
    "total_required": "150.00",
    "total_paid": "150.00",
    "presented_id": 9876,
    "reconciled_presented_id": 9876,
    "invoice_number": "INV-2023-001234",
    "invoice_public_url": "https://in.xero.com/abcdef1234567890",
    "payment_fees": "3.50",
    "nett_of_fees": "146.50",
    "spam_score": "0.2",
    "spam_message": "string",
    "client_ipaddress": "192.168.1.100",
    "validation_messages": "string",
    "event_id": 789,
    "event_instance": "2023-10-15"
  }
]
Response examples (400) 
{
  "error": "Invalid field contents",
  "errors": {
    "errorfield": [
      {
        "code": 400,
        "message": "Invalid value supplied for field"
      }
    ]
  }
}
Response examples (401) 
{
  "error": "Unauthorised"
}
Response examples (403) 
{
  "error": "Invalid Permission"
}