Retrieve a form

GET  https://:account.api-us1.com/api/3/forms/id

• cURL

curl --request GET \
  --url https:///:account.api-us1.com/api/3/forms/id

• Node

var request = require("request");

var options = { method: 'GET',
  url: 'https:///:account.api-us1.com/api/3/forms/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

• Ruby

require 'uri'
require 'net/http'

url = URI("https:///:account.api-us1.com/api/3/forms/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

• JavaScript

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https:///:account.api-us1.com/api/3/forms/id");

xhr.send(data);

• Python

import requests

url = "https:///:account.api-us1.com/api/3/forms/id"

response = requests.request("GET", url)

print(response.text)

 

200 OK

{
    "form": {
        "name": "Test Form",
        "action": "",
        "actiondata": {
            "actions": [
                {
                    "type": "email-results",
                    "email": "[e-mail]",
                    "fromname": "John Doe",
                    "fromemail": "[e-mail]",
                    "subject": "Form submission results"
                }
            ]
        },
        "submit": "show-thank-you",
        "submitdata": {
            "url": ""
        },
        "url": "",
        "layout": "inline-form",
        "title": "",
        "body": "",
        "button": "Submit",
        "thanks": "Thanks for signing up!",
        "style": {
            "background": "FFFFFF",
            "dark": true,
            "fontcolor": "000000",
            "layout": "normal",
            "border": {
                "width": 0,
                "style": "solid",
                "color": "B0B0B0",
                "radius": 0
            },
            "width": 500,
            "ac_branding": true,
            "button": {
                "padding": 10,
                "background": "333333",
                "fontcolor": "FFFFFF",
                "border": {
                    "radius": 4,
                    "color": "333333",
                    "style": "solid",
                    "width": 0
                }
            },
            "customcss": ""
        },
        "options": {
            "blanks_overwrite": true,
            "confaction": "show-message"
        },
        "cfields": [
            {
                "type": "header",
                "header": "Contact Us",
                "class": "_x29498744",
                "required_options": {}
            },
            {
                "type": "html",
                "html": "<p>Please provide the information below and we'll be in touch soon.</p>",
                "class": "_x14271862",
                "required_options": {}
            },
            {
                "header": "Full Name",
                "type": "fullname",
                "default_text": "",
                "class": "_x13100531",
                "required_options": {},
                "required": true
            },
            {
                "header": "Email",
                "type": "email",
                "default_text": "",
                "required": true,
                "class": "_x37378733",
                "required_options": {}
            },
            {
                "type": "organization",
                "header": "Company",
                "default_text": "",
                "class": "_x16906569",
                "required_options": {},
                "required": false
            },
            {
                "id": "13",
                "header": "Role in Company",
                "required": true,
                "class": "_field13",
                "required_options": {}
            },
            {
                "id": "46",
                "header": "What do you need help with?",
                "required": true,
                "class": "_field46",
                "required_options": {}
            }
        ],
        "parentformid": "0",
        "userid": "1",
        "addressid": "0",
        "cdate": "2018-10-07T09:12:46-06:00",
        "udate": "2018-10-12T11:18:52-06:00",
        "entries": "0",
        "aid": null,
        "links": {
            "address": "https://:account.api-us1.com/api/3/forms/13/address"
        },
        "id": "13",
        "address": null
    }
}

403 Forbidden

{
    "message": "No Result found for Form with id 7"
}

PATH PARAMS

id                                                   REQUIRED

string                                             ID of the form to retrieve