View a public form

GET /public-form/form/{form_uuid}
Personal access token & O auth2

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • uuid string

      The UUID of the resource.

    • created_at string

      The timestamp of when the resource was created.

    • updated_at string

      The timestamp of when the resource was updated.

    • stage string

      The stage of the submission

    • account object

      Account responsible for answering the form

    • request object

      Form submission request attached to this submission if it has one

    • form object

      The form that this submission was created for

    • answers array[object]

      The answers to the questions
GET /public-form/form/{form_uuid} 
curl \
 --request GET 'https://api.plannrcrm.com/public-form/form/form_uuid' \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json"
Response examples (200) 
{
  "form": {
    "live": true,
    "uuid": "923f0ed8-f0a7-49cc-b199-f6aba64ffe2d",
    "title": "Annual Catchup 2022",
    "sections": "App\\Http\\Resources\\FormQuestionResource",
    "created_at": "2025-05-14T18:27:17+01:00",
    "updated_at": "2025-05-14T18:27:17+01:00",
    "visibility": "public",
    "client_type": "client",
    "description": "This is the annual catchup form for 2022",
    "allowed_hosts": [
      "domain.com",
      "subdomain.domain.com"
    ],
    "create_client": true,
    "draft_submissions_count": 5,
    "submitted_submissions_count": 5
  },
  "uuid": "3923a6cc-891b-495d-862b-d896cfdebb17",
  "stage": "draft",
  "account": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "3a0795b3-6115-46c5-b370-dce2539280e4",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-05-14T18:27:17+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-05-14T18:27:17+01:00",
    "with_login": true,
    "inactive_at": "2025-05-14",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2025-05-14T18:27:17+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-05-14T18:27:17+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "previous_review_date": "2025-05-14T18:27:17+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-05-14T18:27:17+01:00"
  },
  "answers": [
    {
      "last_name": "olive",
      "first_name": "john"
    }
  ],
  "request": {
    "form": "App\\Http\\Resources\\FormResource",
    "uuid": "94be6f36-78e3-4f49-852b-a2a3bad63a0b",
    "created_at": "2025-05-14T18:27:17+01:00",
    "submission": "App\\Http\\Resources\\FormSubmissionResource",
    "updated_at": "2025-05-14T18:27:17+01:00",
    "description": "Please submit your annual survey form",
    "has_submission": true
  },
  "created_at": "2025-05-14T18:27:17+01:00",
  "updated_at": "2025-05-14T18:27:17+01:00"
}