Ir para o conteúdo

Listar todos os formulários GET ​

Retorne todos os formulários da sua conta, do mais recente para o mais antigo.

Endpoint ​

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

Autenticação ​

Obrigatório

Inclua um destes cabeçalhos na sua requisição:

  • Token: <your-api-key> — Obtenha em Chaves de API
  • Authorization: Bearer <jwt-token> — De Entrar

Requisição ​

Cabeçalhos ​

CabeçalhoObrigatórioDescrição
Token✅Sua chave de API
Authorization✅Bearer <jwt-token>

Exemplo de requisição ​

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;
}

Resposta ​

Resposta de sucesso ​

200 OK

Um array de formulários. Uma conta sem formulários retorna [].

CampoTipoDescrição
tidstringIdentificador do formulário — o link público é https://frms.click/{tid}
namestringNome interno, exibido no seu painel
fieldsarrayOs campos do formulário — veja Criar formulário
settingsobjectTítulo, textos e design — veja Criar formulário
application_tidstringAplicativo ao qual as respostas pertencem (vazio se nenhum)
device_tidstringTID do dispositivo de destino, all, ou vazio para todos os dispositivos
default_levelint | nullNível de prioridade aplicado às respostas (-2..2)
push_titlestringModelo do título da notificação push (vazio significa Form: {name})
allowed_originsarrayHosts autorizados a incorporar e enviar o formulário (vazio significa qualquer lugar)
max_responsesintLimite de respostas, 0 para ilimitado
closes_atstring | nullHorário de encerramento, RFC 3339 em UTC
closedbooleanSe o formulário está, no momento, recusando envios
is_activebooleanA chave de ativação/desativação do proprietário
submissions_countintRespostas recebidas até agora
last_submission_atstringÚltima resposta, no fuso horário da sua conta
created_atstringData de criação, no fuso horário da sua conta
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"
  }
]

Respostas de erro ​

StatusDescrição
401Não autorizado — token inválido ou ausente
500Falha ao carregar os formulários

Documentação do Pocket Alert