Перейти к содержимому

Получение всех форм GET ​

Получите все формы вашего аккаунта, сначала самые новые.

Эндпоинт ​

GET https://api.pocketalert.app/v1/forms

Аутентификация ​

Обязательно

Добавьте в запрос один из этих заголовков:

  • Token: <your-api-key> — получите его в разделе API-ключи
  • Authorization: Bearer <jwt-token> — из входа

Запрос ​

Заголовки ​

ЗаголовокОбязательныйОписание
Token✅Ваш API-ключ
Authorization✅Bearer <jwt-token>

Пример запроса ​

bash
curl -X GET "https://api.pocketalert.app/v1/forms" \
  -H "Token: your-api-key"
javascript
const response = await fetch('https://api.pocketalert.app/v1/forms', {
  headers: { 'Token': 'your-api-key' }
});

const forms = await response.json();
forms.forEach((form) => console.log(form.name, `https://frms.click/${form.tid}`));
python
import requests

response = requests.get(
    'https://api.pocketalert.app/v1/forms',
    headers={'Token': 'your-api-key'}
)

for form in response.json():
    print(form['name'], f"https://frms.click/{form['tid']}")
php
$forms = Http::withHeaders([
    'Token' => 'your-api-key',
])->get('https://api.pocketalert.app/v1/forms')->json();

foreach ($forms as $form) {
    echo $form['name'].' https://frms.click/'.$form['tid'].PHP_EOL;
}

Ответ ​

Успешный ответ ​

200 OK

Массив форм. Если в аккаунте нет форм, возвращается [].

ПолеТипОписание
tidstringИдентификатор формы — публичная ссылка имеет вид https://frms.click/{tid}
namestringВнутреннее название, отображается в вашей панели
fieldsarrayПоля формы — см. Создание формы
settingsobjectЗаголовок, тексты и оформление — см. Создание формы
application_tidstringПриложение, к которому относятся ответы (пусто, если не задано)
device_tidstringTID целевого устройства, all или пусто для всех устройств
default_levelint | nullУровень приоритета, применяемый к ответам (-2..2)
push_titlestringШаблон заголовка push-уведомления (пусто означает Form: {name})
allowed_originsarrayХосты, которым разрешено встраивать форму и отправлять её (пусто означает без ограничений)
max_responsesintОграничение на количество ответов, 0 — без ограничений
closes_atstring | nullВремя закрытия в формате RFC 3339, UTC
closedbooleanПринимает ли форма сейчас ответы
is_activebooleanПереключатель включения и выключения, установленный владельцем
submissions_countintКоличество полученных ответов
last_submission_atstringПоследний ответ, во времени вашего аккаунта
created_atstringДата создания, во времени вашего аккаунта
json
[
  {
    "tid": "vml19aihrga216gt8apc5e3m9",
    "name": "Contact form",
    "fields": [
      { "id": "name", "type": "text", "label": "Name", "placeholder": "Jane Doe", "required": true },
      { "id": "email", "type": "email", "label": "Email", "placeholder": "[email protected]", "required": true }
    ],
    "settings": {
      "title": "Get in touch",
      "top_text": "Leave your details and we will get back to you shortly.",
      "primary_color": "#3f5cad",
      "submit": { "text": "Submit", "color": "", "size": "md" }
    },
    "application_tid": "qm47b9pzxzx7applfd0",
    "device_tid": "",
    "default_level": null,
    "push_title": "New lead: {Name}",
    "allowed_origins": ["example.com"],
    "max_responses": 0,
    "closes_at": null,
    "closed": false,
    "is_active": true,
    "submissions_count": 12,
    "last_submission_at": "23.09.2026 14:05:11",
    "created_at": "20.09.2026 09:12:40"
  }
]

Ответы с ошибками ​

СтатусОписание
401Unauthorized — токен недействителен или отсутствует
500Не удалось загрузить формы

Документация Pocket Alert