curl --request POST \
--url https://cloudapi.mailercloud.com/v1/webform/search \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"limit": 0,
"page": 0,
"search": "string",
"sort_field": "string",
"sort_order": "string",
"date_from": "string",
"date_to": "string",
"status": "string"
}
'import requests
url = "https://cloudapi.mailercloud.com/v1/webform/search"
payload = {
"limit": 0,
"page": 0,
"search": "string",
"sort_field": "string",
"sort_order": "string",
"date_from": "string",
"date_to": "string",
"status": "string"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
limit: 0,
page: 0,
search: 'string',
sort_field: 'string',
sort_order: 'string',
date_from: 'string',
date_to: 'string',
status: 'string'
})
};
fetch('https://cloudapi.mailercloud.com/v1/webform/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://cloudapi.mailercloud.com/v1/webform/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'limit' => 0,
'page' => 0,
'search' => 'string',
'sort_field' => 'string',
'sort_order' => 'string',
'date_from' => 'string',
'date_to' => 'string',
'status' => 'string'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://cloudapi.mailercloud.com/v1/webform/search"
payload := strings.NewReader("{\n \"limit\": 0,\n \"page\": 0,\n \"search\": \"string\",\n \"sort_field\": \"string\",\n \"sort_order\": \"string\",\n \"date_from\": \"string\",\n \"date_to\": \"string\",\n \"status\": \"string\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"value": {
"count": 0,
"data": [
{
"embed_code": "string",
"id": "string",
"last_updated": "string",
"linked_list": "string",
"name": "string",
"new_contact_count": 0,
"status": "string",
"submission_count": 0,
"type": "string",
"view_count": 0
}
]
}
}Webform List
Use this API to return an array of all of your webforms. You can filter, search and sort webforms.
curl --request POST \
--url https://cloudapi.mailercloud.com/v1/webform/search \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"limit": 0,
"page": 0,
"search": "string",
"sort_field": "string",
"sort_order": "string",
"date_from": "string",
"date_to": "string",
"status": "string"
}
'import requests
url = "https://cloudapi.mailercloud.com/v1/webform/search"
payload = {
"limit": 0,
"page": 0,
"search": "string",
"sort_field": "string",
"sort_order": "string",
"date_from": "string",
"date_to": "string",
"status": "string"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
limit: 0,
page: 0,
search: 'string',
sort_field: 'string',
sort_order: 'string',
date_from: 'string',
date_to: 'string',
status: 'string'
})
};
fetch('https://cloudapi.mailercloud.com/v1/webform/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://cloudapi.mailercloud.com/v1/webform/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'limit' => 0,
'page' => 0,
'search' => 'string',
'sort_field' => 'string',
'sort_order' => 'string',
'date_from' => 'string',
'date_to' => 'string',
'status' => 'string'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://cloudapi.mailercloud.com/v1/webform/search"
payload := strings.NewReader("{\n \"limit\": 0,\n \"page\": 0,\n \"search\": \"string\",\n \"sort_field\": \"string\",\n \"sort_order\": \"string\",\n \"date_from\": \"string\",\n \"date_to\": \"string\",\n \"status\": \"string\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"value": {
"count": 0,
"data": [
{
"embed_code": "string",
"id": "string",
"last_updated": "string",
"linked_list": "string",
"name": "string",
"new_contact_count": 0,
"status": "string",
"submission_count": 0,
"type": "string",
"view_count": 0
}
]
}
}Authorizations
Your Mailercloud API key (plain text, no Bearer prefix). Create keys in Settings → API.
Headers
application/json
Body
Maximum number of elements to return.
Maximum: 100 Minimum: 10
You can retrieve a subset of records starting from the page value you have specified. You can add a limit, which will determine the number of records you can retrieve on a single page.
Starts From: 1
Filter form by name , giving name in search keyword
1Sort list data based on this field
Available sort fields - name, modifiedDate, view_count, submission_count, new_contact_count
1If sort_field is given then sort_order is required
Sorting order for sort field
Available sort orders - asc, ASC, desc, DESC
1Filter forms based on modified date.
1Filter forms based on modified date.
1Filter forms based on status. Set status to Active to get forms with embed code.
Available status – Active, Inactive, Draft, Duplicate
1