curl --request GET \
--url https://api.mercemur.com/api/v1/marketing-forms/{formId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.mercemur.com/api/v1/marketing-forms/{formId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.mercemur.com/api/v1/marketing-forms/{formId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.mercemur.com/api/v1/marketing-forms/{formId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mercemur.com/api/v1/marketing-forms/{formId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": {
"consent": {
"email": {
"double_opt_in": true,
"mode": "<string>",
"pre_checked": true,
"required": true,
"text": "<string>"
},
"sms": {
"double_opt_in": true,
"mode": "<string>",
"pre_checked": true,
"required": true,
"text": "<string>"
}
},
"created_at": "<string>",
"fields": [
{
"key": "<string>",
"label": "<string>",
"options": [
"<unknown>"
],
"placeholder": "<string>",
"required": true,
"type": "<string>"
}
],
"id": "<string>",
"name": "<string>",
"status": "<string>",
"success": {
"message": "<string>",
"redirect_url": "<string>",
"reveal_coupon": true
},
"targeting": {
"device": "<string>",
"exclude_urls": [
{
"op": "<string>",
"value": "<string>"
}
],
"frequency": {
"after_dismiss": {
"days": 123,
"unit": "<string>"
},
"after_submit": {
"days": 123,
"unit": "<string>"
}
},
"include_urls": [
{
"op": "<string>",
"value": "<string>"
}
],
"priority": 123,
"trigger": {
"delay_seconds": 123,
"idle_seconds": 123,
"kind": "<string>",
"scroll_percent": 123
}
},
"type": "<string>",
"updated_at": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"resource": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"resource": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"resource": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"resource": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"resource": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"resource": "<string>",
"field": "<string>"
}
}Retrieve a marketing form
One signup form, in the same shape the list and the writes serve.
curl --request GET \
--url https://api.mercemur.com/api/v1/marketing-forms/{formId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.mercemur.com/api/v1/marketing-forms/{formId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.mercemur.com/api/v1/marketing-forms/{formId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.mercemur.com/api/v1/marketing-forms/{formId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mercemur.com/api/v1/marketing-forms/{formId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": {
"consent": {
"email": {
"double_opt_in": true,
"mode": "<string>",
"pre_checked": true,
"required": true,
"text": "<string>"
},
"sms": {
"double_opt_in": true,
"mode": "<string>",
"pre_checked": true,
"required": true,
"text": "<string>"
}
},
"created_at": "<string>",
"fields": [
{
"key": "<string>",
"label": "<string>",
"options": [
"<unknown>"
],
"placeholder": "<string>",
"required": true,
"type": "<string>"
}
],
"id": "<string>",
"name": "<string>",
"status": "<string>",
"success": {
"message": "<string>",
"redirect_url": "<string>",
"reveal_coupon": true
},
"targeting": {
"device": "<string>",
"exclude_urls": [
{
"op": "<string>",
"value": "<string>"
}
],
"frequency": {
"after_dismiss": {
"days": 123,
"unit": "<string>"
},
"after_submit": {
"days": 123,
"unit": "<string>"
}
},
"include_urls": [
{
"op": "<string>",
"value": "<string>"
}
],
"priority": 123,
"trigger": {
"delay_seconds": 123,
"idle_seconds": 123,
"kind": "<string>",
"scroll_percent": 123
}
},
"type": "<string>",
"updated_at": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"resource": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"resource": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"resource": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"resource": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"resource": "<string>",
"field": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"resource": "<string>",
"field": "<string>"
}
}Authorizations
A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.
Path Parameters
Response
Success
Show child attributes
Show child attributes
