A Form resource represents a single form within a given agency. This may be a form in either the “Draft” or “Published” status and may even include deleted forms. The Form list resource represents a set of forms in a given agency.
HTTP GET
GET /api/2013-12-01/Forms/[Agency ID]
Returns a list of forms for a given [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 |
|---|---|
| Form_ID | Search for a specific Form ID |
| User_ID | Filter forms to show only those created by a specific user. |
| Name | Filter forms with a matching Name. The % character can be used to designate a wildcard. |
| Description | Filter forms with a matching Description. The % character can be used to designate a wildcard. |
| Status | Only show forms with the specified status. Valid statuses include “Deleted”, “Draft”, “Published”. Defaults to “Published”, 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] \
-u "[API Account ID]:[API Token]"Request Result
{
"code": 0,
"status": 200,
"detail": "Success",
"timestamp": "2020-01-15T22:39:58+00:00",
"users": [
{
"Form ID": "1234",
"Created": 1593962058,
"Creator": {
"User ID": 1234,
"Name": "John Doe"
},
"Description": "Test Form Description",
"Name": "Test Form",
"Status": "Published"
}, ...
],
"results": 123,
"pages": 2,
"page": 1,
"page_start": 100,
"page_end": 122,
"page_size": 100
}Example Request
Show only those forms where the Name field begins with “Test”.
$ curl -G https://[Site Name].readyop.com/api/2013-12-01/Forms/[Agency ID] \
-d "Name=Test%" \
-u "[API Account ID]:[API Token]"Request Result
{
"code": 0,
"status": 200,
"detail": "Success",
"timestamp": "2020-01-15T22:39:58+00:00",
"users": [
{
"Form ID": "1234",
"Created": 1593962058,
"Creator": {
"User ID": 1234,
"Name": "John Doe"
},
"Description": "Test Form Description",
"Name": "Test Form",
"Status": "Published"
}, ...
],
"results": 123,
"pages": 2,
"page": 1,
"page_start": 100,
"page_end": 122,
"page_size": 100
}