forms

List form submissions

What visitors submitted through site forms, newest first. Poll with unread=true as an intake queue.

payload is the form's fields exactly as the visitor filled them; the shape follows the form on the page, so read it defensively.

unread=true returns only submissions not yet marked read. Poll it, ingest, then PATCH each one read for an at-least-once intake loop.

site_id narrows to one site; business_id to one business's sites (one you can access, else 403); limit caps the page (default 50, max 200).

get/api/v1/form-submissions

Request

  • Base URL: https://app.blueticked.com
  • URL: https://app.blueticked.com/api/v1/form-submissions
  • Auth: HTTP bearer

Query parameters

site_idstring

Filter by site_id.

unreadstring

Filter by unread.

limitinteger

Maximum number of items to return.

Response

Success

okboolean required

Example response

{
  "ok": true,
  "submissions": [
    {
      "id": "4b8c2d1e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
      "site_id": "1d3dd43a-1f0a-4e83-ae13-4494e0d967b3",
      "page_slug": "contact",
      "payload": {
        "name": "Naledi Dlamini",
        "phone": "+27800000001",
        "message": "Do you deliver to Stellenbosch?"
      },
      "created_at": "2026-08-05T09:12:00.000Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.