Retrieve a list of forms

get

/api/REST/1.0/assets/forms

Retrieves all forms that match the criteria specified by the request parameters. Note: You can also retrieve a list of forms via REST 2.0 by using the endpoint REST/2.0/assets/forms.

Request

Supported Media Types
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : QueryResultForm
Type: object
Title: QueryResultForm
Show Source
Nested Schema : elements
Type: array
Array of form fields.
Show Source
Nested Schema : Form
Type: object
Title: Form
Show Source
Nested Schema : elements
Type: array
Array consisting of form elements.
Show Source
Nested Schema : processingSteps
Type: array
A list of the form's processing steps. There is no limit to the number of processing steps that can be included. Possible values include: FormStepAddToCampaign, FormStepAddToContactList, FormStepAddToDataCanvas, FormStepAddToProgram, FormStepAssociateToCampaign, FormStepCancelRegistration, FormStepUpdateContactEmailAddress, FormStepCreateUpdateEventRegistration, FormStepCreateUpdate, FormStepCreateUpdateFromFormField, FormStepGlobalSubscribe, FormStepGlobalUnsubscribe, FormStepGroupSubscription, FormStepPostData, FormStepRedirectToWebPage, FormStepRemoveFromContactList, FormStepRunIntegrationRules, FormStepSendEmail, FormStepSendNotificationEmail, and FormStepWebTracking.
Show Source
Nested Schema : FormElement
Type: object
Title: FormElement
Show Source
Nested Schema : FormProcessingStep
Type: object
Title: FormProcessingStep
Show Source

400 Response

Bad request. See Status Codes for information about other possible HTTP status codes.

401 Response

Unauthorized. See Status Codes for information about other possible HTTP status codes.

403 Response

Forbidden. See Status Codes for information about other possible HTTP status codes.

404 Response

The requested resource was not found. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an error. See Status Codes for information about other possible HTTP status codes.
Back to Top

Examples

Retrieve the first 2 forms in your database:


GET /api/REST/1.0/assets/forms?count=2
			

Response:


{
  "elements": [
    {
      "type": "Form",
      "currentStatus": "Draft",
      "id": "75",
      "createdAt": "1554748229",
      "createdBy": "52",
      "depth": "minimal",
      "folderId": "4220",
      "name": "The Amazing Form!",
      "permissions": "fullControl",
      "updatedAt": "1586954686",
      "updatedBy": "52",
      "archived": "false",
      "htmlName": "responsiveform-1554748226676"
    },
    {
      "type": "Form",
      "currentStatus": "Draft",
      "id": "101",
      "createdAt": "1586894543",
      "createdBy": "35",
      "depth": "minimal",
      "folderId": "4124",
      "name": "Kiosk Form",
      "permissions": "fullControl",
      "updatedAt": "1586894551",
      "updatedBy": "35",
      "archived": "false",
      "htmlName": "responsiveform-1586894918064"
    }
  ],
  "page": 1,
  "pageSize": 2,
  "total": 72
}
			
Back to Top