Form Object

Use forms to collect visitor information and create identified prospects. Learn more about forms in Salesforce Help.

Include the authentication header with every request. For information on how to authenticate, see Authentication.

Note

Form Resources

Resource Name	Operation	Description
Form Query	`GET`	Request information for the forms that match the specified criteria.
Form Read	`GET`	Request information for a single form.

Form Query

Request information for forms that match the specified criteria. You can specify the forms and fields to request. A maximum of 200 records are returned. To return all forms, specify the output as mobile.

URI

1/api/form/version/4/do/query?...

Parameters to Select Forms

Use these parameters to specify the forms to return. Parameters can be used in any combination and in any order unless otherwise specified.

Notes:

Parameters must be URL-encoded.
Dates and times must use GNU Date Input Syntax (yyyy-mm-dd:hh:ss:mm).
For a full listing of form fields see Object Field References.

Parameter	Type	Possible Values	Description
`created_after`	`string`	`today`, `yesterday`, `last_7_days`, `this_month`, `last_month`,`<custom_time>`	Request forms created after the specified time. Example: To request forms created in 2020, use `/api/form/version/4/do/query?created_after=2019-12-31 24:59:59`.
`created_before`	`string`	`today`, `yesterday`, `last_7_days`, `this_month`, `last_month`, `<custom_time>`	Request forms created before the specified time. Doesn’t include forms created at the specified time. Example: to request forms created before today (but not created today), use `/api/form/version/4/do/query?created_before=today`.
`id_greater_than`	`integer`	Any positive integer	Request forms that have an Account Engagement ID greater than the specified number.
`id_less_than`	`integer`	Any positive integer	Request forms that have an Account Engagement ID less than the specified number.
`updated_after`	`string`	`today`, `yesterday`, `last_7_days`, `this_month`, `last_month`, `<custom_time>`	Request forms that were last updated after the specified time.
`updated_before`	`string`	`today`, `yesterday`, `last_7_days`, `this_month`, `last_month`, `<custom_time>`	Request forms that were last updated before the specified time.

Parameters to Specify Which Results Are Returned

Use these parameters to specify which forms to return, and how the forms are sorted.

Parameter	Type	Possible Values	Description
`limit`	`integer`	Any integer from 1 through 200.	The number of forms to return. Default value is 200.
`offset`	`integer`	Any positive integer	The number of forms to omit from the response (the number to “skip over”). Example: Retrieve a list of forms, omitting the 50 most recently updated forms. Sort the query by the `updated_at` field and use offset=50: `/api/form/version/4/do/query?sort_by=updated_at&offset=50`
`sort_by`	`string`	`created_at`, `id`, `updated_at`	The field by which the results are sorted. See Sort Order.
`sort_order`	`string`	`ascending, descending`	The sort order. The default value depends on which `sort_by` parameter you specify. See Sort Order.

Sort Order

Use sort_by to specify which field Account Engagement uses to sort the results. Different fields have different default sort orders.

Value	Default Sort Order	Description
`created_at`	descending	Sort the results by the forms’ `created_at` timestamps.
`id`	ascending	Sort the results by the forms’ `id` fields.
`updated_at`	descending	Sort the results by the forms’ `updated_at` timestamps.

Form Read

Request information for a single form.

URI

1/api/form/version/4/do/read/id/<ID>

Replace <ID> with the Account Engagement ID of the form.

Example

Request information about the form with ID 1234.

1/api/form/version/4/do/read/id/1234

XML Response

The XML response for a query request contains information for multiple forms. The XML response for a read request contains information for a single form.

XML Response for a Form Query

1<rsp stat="ok" version="1.0">
2    <result>
3        <total_results>...</total_results>
4        <form>...</form>
5        <form>...</form>
6        <form>...</form>
7    </result>
8</rsp>

Tag	Description
`<result>`	Contains the information about the forms that match the parameters specified in your query.
`<total_results>`	Contains the number of forms selected by the query. Note: The query request returns a maximum of 200 forms. If your query matches more than 200 forms, you can make several requests to retrieve all matching forms.
`<form>`	The information about an individual form. See Form in Object Field References for a complete description of fields.

XML Response for a Form Read

1<?xml version="1.0" encoding="UTF-8"?>
2<rsp stat="ok" version="1.0">
3    <form>
4        <id>38756</id>
5        <name>Demo Request</name>
6        <campaign>
7            <id>113156</id>
8            <name>Website Tracking</name>
9        </campaign>
10        <embedCode> </embedCode>
11        <created_at>2020-04-20 00:00:00</created_at>
12        <updated_at>2020-10-15 12:25:17</updated_at>
13    </form>
14</rsp>

Tag	Description
`<form>`	The information about an individual form. See Form in Object Field References for a complete description of fields.
`<campaign>`	Contains the Account Engagement ID and name of the campaign to which this form is assigned.
`<embedCode>`	Contains the iframe of the form that you can embed on your webpage.