Forms

The API to access the Form object collection follows the conventions described in Version 5 Overview.

Supported Operations

Fields

Required Editable Fields

None.

Optional Editable Fields

None.

Read-Only Fields

Form Read

Retrieve a single form object following the conventions described in the Version 5 Overview.

Example request:

GET /api/v5/objects/forms/101?fields=id,name,isDeleted,thankYouContent,submitButtonText,campaign.name,createdBy.username,updatedBy.username,createdAt,updatedAt
Host: pi.pardot.com
Authorization: Bearer <access-token>

Example response:

HTTP/1.1 200 OK
Content-Type: application/json
{
    "id": 101,
    "name": "Standard Form",
    "isDeleted": false,
    "thankYouContent": "<p>Thank you for filling out the form. We will get back to you shortly.</p>",
    "submitButtonText": "Submit",
    "campaign": {
        "name": "My Campaign"
    },
    "createdAt": "2020-09-29T09:36:56-04:00",
    "updatedAt": "2020-09-29T09:36:56-04:00",
    "createdBy": {
        "username": "jsmith@example.com"
    },
    "updatedBy": {
        "username": "jsmith@example.com"
    }
}

Form Query

Retrieving a collection of forms follows the conventions described in Version 5 Overview.

Sortable Fields

When executing a query, the following fields can be specified. See the conventions for query described in the Version 5 Overview.

• id

Example request:

GET /api/v5/objects/forms?fields=id,name,isDeleted,thankYouContent,submitButtonText,campaign.name,createdBy.username,updatedBy.username,createdAt,updatedAt
Host: pi.pardot.com
Authorization: Bearer <access-token>

Example response:

HTTP/1.1 200 OK
Content-Type: application/json
{
    "values": [
        {
            "id": 101,
            "name": "Standard Form",
            "isDeleted": false,
            "thankYouContent": "<p>Thank you for filling out the form. We will get back to you shortly.</p>",
            "submitButtonText": "Submit",
            "campaign": {
                "name": "My Campaign"
            },
            "createdAt": "2020-09-29T09:36:56-04:00",
            "updatedAt": "2020-09-29T09:36:56-04:00",
            "createdBy": {
                "username": "jsmith@example.com"
            },
            "updatedBy": {
                "username": "jsmith@example.com"
            }
        }
    ]
}

Filtering Results

When executing a query, the following parameters can be used to filter the returned results. These parameters can be specified in the request along with any shared parameters defined in Version 5 Overview. When specifying more than one parameter, all parameters must match the record in order for it to be returned in the results.

Example request:

GET /api/v5/objects/forms?fields=id,name&orderBy=id desc&idGreaterThan=150&idLessThan=200
Host: pi.pardot.com
Authorization: Bearer <access-token>

Example response:

HTTP/1.1 200 OK
Content-Type: application/json
{
    "values": [
        {
            "id": 168,
            "name": "Spring Intake Form"
        },
        {
            "id": 151,
            "name": "Contact Form"
        }
    ]
}