Obter formulário público GET
Leia um formulário ativo da mesma forma que o navegador de um visitante: seus campos e design, sem nada privado. Sem autenticação. Este é o endpoint que a própria página do formulário chama.
Endpoint
GET https://api.pocketalert.app/v1/forms/{tid}Autenticação
Não é necessária
O endpoint é público. Ele nunca retorna o título da notificação push, o roteamento, o contador de respostas nem qualquer outra coisa que o dono vê.
Requisição
Parâmetros de caminho
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
tid | string | ✅ | Identificador do formulário, o mesmo que aparece em https://frms.click/{tid} |
Exemplo de requisição
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')Resposta
Resposta de sucesso
200 OK
Um formulário fechado ainda responde com 200, com closed: true e um array fields vazio. É assim que a página sabe que deve mostrar closed_message em vez dos campos.
| Campo | Tipo | Descrição |
|---|---|---|
tid | string | Identificador do formulário |
closed | boolean | true quando o formulário está desligado, passou da data de encerramento ou esgotou as vagas de respostas |
fields | array | Os campos a renderizar. Veja Criar formulário. Vazio quando closed |
settings | object | Título, textos e design. Veja Criar formulário |
allowed_origins | array | Hosts autorizados a incorporar o formulário; vazio significa qualquer um |
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": []
}Campos ocultos
Um campo hidden não é renderizado. Seu valor vem da URL da página: ?utm_source=newsletter preenche o campo cujo param é utm_source, e ele é enviado junto com a submissão.
Respostas de erro
| Status | Descrição |
|---|---|
404 | Formulário não encontrado |