List all forms

List the account's forms with their settings, fields and actions. Each form's public_url is its public link and embed_code is the snippet to place it on a website. url is the builder's preview website, not the public link.

{
    "forms": [
        {
            "name": "Testing",
            "action": "",
            "actiondata": {
                "actions": [
                    {
                        "type": "subscribe-to-list",
                        "email": "[email protected]",
                        "list": "1"
                    }
                ]
            },
            "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
                    }
                }
            },
            "options": {
                "blanks_overwrite": true,
                "confaction": "show-message",
                "sendoptin": true,
                "optin_id": 1,
                "optin_created": true,
                "confform": "2"
            },
            "cfields": [
                {
                    "type": "header",
                    "header": "Subscribe for Email Updates",
                    "class": "_x41699710"
                },
                {
                    "type": "html",
                    "html": "<p>Add a descriptive message telling what your visitor is signing up for here.</p>",
                    "class": "_x50329289"
                },
                {
                    "header": "Full Name",
                    "type": "fullname",
                    "default_text": "Type your name",
                    "class": "_x67999677"
                },
                {
                    "header": "Email",
                    "type": "email",
                    "default_text": "Type your email",
                    "required": true,
                    "class": "_x68140262"
                }
            ],
            "parentformid": "0",
            "userid": "1",
            "addressid": "0",
            "cdate": "2018-08-17T13:47:31-05:00",
            "udate": "2018-08-17T13:47:38-05:00",
            "entries": "0",
            "aid": "0",
            "defaultscreenshot": "http://img-us1.com/default-form.gif",
            "recent": [],
            "contacts": 0,
            "deals": 0,
            "links": {
                "address": "https://:account.api-us1.com/api/3/forms/1/address"
            },
            "id": "1",
            "address": null
        }
    ],
    "meta": {
        "total": "1"
    }
}
Query Params
int32
≤ 100
Defaults to 20

Number of forms to return. Defaults to 20, and values above 100 are reduced to 100.

int32
Defaults to 0

Number of forms to skip, for paging.

string

Return only these forms. One id, or several separated by commas. Supersedes limit, which becomes the number of ids given.

Return only forms whose name contains this text.

layout[]
array of strings

Return only forms with these layouts, sent as layout[]=<layout> once per layout. A single layout=<layout> works too.

layout[]
Allowed:
int32

Return only forms in this folder (form label), by its id. -1 returns forms in no folder; 0 returns every form, as leaving it out does.

string
enum

Return only forms with an action of this type.

Allowed:
boolean

true lists only forms that show the ActiveCampaign branding badge (style.ac_branding), false only forms that don't, including forms that never set it. Left out or empty: every form. Any other value returns 422.

string
enum
Defaults to name

Order of the forms, by name A to Z when left out or not one of these: name or nameD by name, layout or layoutD by layout, entries or entriesD by number of submissions, cdateA or cdateD by created date. The values ending in D sort descending. Forms that tie are ordered newest id first.

integer
enum

1 adds each form's folders (form labels) to it as labelsData. Any other value leaves them out.

Allowed:
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json