Skip to content

Get All Forms GET

Retrieve every form in your account, newest first.

Endpoint

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

Authentication

Required

Include one of these headers in your request:

  • Token: <your-api-key> — Get it from API Keys
  • Authorization: Bearer <jwt-token> — From Login

Request

Headers

HeaderRequiredDescription
TokenYour API key
AuthorizationBearer <jwt-token>

Example Request

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

Response

Success Response

200 OK

An array of forms. An account with no forms returns [].

FieldTypeDescription
tidstringForm identifier — the public link is https://frms.click/{tid}
namestringInternal name, shown in your dashboard
fieldsarrayThe form's fields — see Create Form
settingsobjectTitle, texts and design — see Create Form
application_tidstringApplication the submissions belong to (empty if none)
device_tidstringTarget device TID, all, or empty for every device
default_levelint | nullPriority level applied to submissions (-2..2)
push_titlestringPush title template (empty means Form: {name})
allowed_originsarrayHosts allowed to embed and submit the form (empty means anywhere)
max_responsesintResponse cap, 0 for unlimited
closes_atstring | nullClosing time, RFC 3339 in UTC
closedbooleanWhether the form currently refuses submissions
is_activebooleanThe owner's on/off switch
submissions_countintResponses received so far
last_submission_atstringLast response, in your account timezone
created_atstringCreation date, in your account timezone
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"
  }
]

Error Responses

StatusDescription
401Unauthorized — Invalid or missing token
500Failed to load forms

Pocket Alert Documentation