An Entry resource represents a single entry (submission) for a specific form within a given agency. This may be an entry in either the “Submitted” or “Deleted” status. The Entries list resource represents a set of entries for a specific form in a given agency.
HTTP GET
GET /api/2013-12-01/Forms/[Agency ID]/[Form ID]/entries
Returns a list of forms for the given [Form ID] and [Agency ID].
Paging
Paging can be accomplished by passing the Page request parameter. By default, only 100 forms are returned per request. You can use the Page_Size request parameter to specify up to 10,000 forms per request.
List Filters
The following list of parameters are available to help limit or filter the records returned. All parameters are case sensitive.
| Parameter | Description |
|---|---|
| Entry_ID | Search for a specific Entry ID |
| User_ID | Filter entries to show only those submitted by a specific user. |
| Status | Only show entries with the specified status. Valid statuses include “Archived”, “Deleted”, “Submitted”. Defaults to “Submitted”, if a status is not specified. |
Example Request
Fetch the entire list.
$ curl -G https://[Site Name].readyop.com/api/2013-12-01/Forms/[Agency ID]/[Form ID]/entries \
-u "[API Account ID]:[API Token]"Request Result
{
"code": 0,
"status": 200,
"detail": "Success",
"timestamp": "2020-07-07T21:24:07+00:00",
"entries": [
{
"Entry ID": 4321,
"Submitted": 1583810247,
"Submitter": {
"User ID": 1,
"Name": "John Smith",
"Type": "User"
},
"Status": "Submitted",
"Updated": 1583810247,
"Data": [
{
"type": "name",
"name": "Name",
"value": [
"Jane",
"Doe"
],
"format": "FL"
},
{
"type": "date",
"name": "Date of Birth",
"value": "12/30/1991",
"format": "MM/DD/YYYY"
},
{
"type": "email",
"name": "Email Address",
"value": "no@email.com"
}, ...
]
}, ...
],
"results": 26,
"pages": 1,
"page": 0,
"page_start": 0,
"page_end": 25,
"page_size": 100
}