Получить публичную форму GET
Прочитайте действующую форму так, как её видит браузер посетителя: поля и оформление, без всего приватного. Аутентификация не нужна — это тот самый эндпоинт, который вызывает сама страница формы.
Эндпоинт
GET https://api.pocketalert.app/v1/forms/{tid}Аутентификация
Не требуется
Эндпоинт публичный. Он никогда не возвращает заголовок push-уведомления, маршрутизацию, счётчик ответов и всё остальное, что видит владелец.
Запрос
Параметры пути
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
tid | string | ✅ | Идентификатор формы, тот же, что отображается в https://frms.click/{tid} |
Пример запроса
bash
curl -X GET "https://api.pocketalert.app/v1/forms/vml19aihrga216gt8apc5e3m9"javascript
const form = await fetch('https://api.pocketalert.app/v1/forms/vml19aihrga216gt8apc5e3m9')
.then((response) => response.json());
if (form.closed) {
console.log(form.settings.closed_message);
} else {
console.log(form.settings.title, form.fields.length, 'fields');
}python
import requests
form = requests.get('https://api.pocketalert.app/v1/forms/vml19aihrga216gt8apc5e3m9').json()
print(form['settings']['title'], len(form['fields']), 'fields')Ответ
Успешный ответ
200 OK
Закрытая форма тоже отвечает кодом 200, с closed: true и пустым массивом fields. Так страница понимает, что нужно показать closed_message вместо полей ввода.
| Поле | Тип | Описание |
|---|---|---|
tid | string | Идентификатор формы |
closed | boolean | true, когда форма выключена, после времени закрытия или когда закончились слоты для ответов |
fields | array | Поля для отображения — см. Создание формы. Пусто, если closed |
settings | object | Заголовок, тексты и оформление — см. Создание формы |
allowed_origins | array | Хосты, которым разрешено встраивать форму; пустой массив означает, что можно откуда угодно |
json
{
"tid": "vml19aihrga216gt8apc5e3m9",
"closed": false,
"fields": [
{ "id": "name", "type": "text", "label": "Name", "placeholder": "Jane Doe", "required": true },
{ "id": "email", "type": "email", "label": "Email", "placeholder": "[email protected]", "required": true },
{ "id": "src", "type": "hidden", "label": "Source", "param": "utm_source" }
],
"settings": {
"title": "Get in touch",
"top_text": "We reply within one business day.",
"success_message": "Thanks! Your response has been sent.",
"closed_message": "This form is no longer accepting responses.",
"background_color": "#f5f5f4",
"card_color": "#ffffff",
"text_color": "#1c1917",
"primary_color": "#3f5cad",
"font_family": "Inter",
"font_size": 16,
"font_weight": 400,
"border_radius": 10,
"hide_branding": false,
"submit": { "text": "Submit", "color": "", "size": "md" }
},
"allowed_origins": []
}Скрытые поля
Поле hidden не отображается. Его значение берётся из URL страницы: ?utm_source=newsletter заполняет поле, у которого param равен utm_source, и это значение передаётся вместе с отправкой.
Ответы с ошибками
| Статус | Описание |
|---|---|
404 | Форма не найдена |