1. Documentation
2. API
3. Forms
4. List

Listing Forms

Get a list of Forms, reverse ordered by created date. Use parameters to filter the list.

HTTP Request

GET https://utilityapi.com/api/v2/forms

Examples

# Get a list of all Forms
curl -H 'Authorization: Bearer API_TOKEN_HERE' \
    'https://utilityapi.com/api/v2/forms'

# Get some specific forms 123 and 456
curl -H 'Authorization: Bearer API_TOKEN_HERE' \
    'https://utilityapi.com/api/v2/forms?uids=123,456'

# Get all archived Forms
curl -H 'Authorization: Bearer API_TOKEN_HERE' \
    'https://utilityapi.com/api/v2/forms?is_archived=true'

# Get the Forms for a specific user
curl -H 'Authorization: Bearer API_TOKEN_HERE' \
    'https://utilityapi.com/api/v2/forms?users=6744'

# GET the Forms based on a specific template
curl -H 'Authorization: Bearer API_TOKEN_HERE' \
    'https://utilityapi.com/api/v2/forms?templates=123333'

Query Parameters

Response

Returns a FormListing object containing a list of Form objects. If the number of results is over 1000, a next parameter will have the link to the next in the series of lists.

// Example result
{
    "forms": [
        {"uid": "12837438", "created": ...},
        {"uid": "12837438", "created": ...},
        ...
    ],
    "next": null,
}

FormListing

This is the object that contains the Form results for the request. We don't just return a straight list of results so that we can paginate results if needed. Currently, the maximum results per request is set at 1000.

// Example FormListing
{
    "forms": [...],
    "next": null,
}

HTTP Response Codes