View a public form

GET /public-form/form/{form_uuid}

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

      Additional properties are allowed.

    • request object

      Form submission request attached to this submission if it has one

      Additional properties are allowed.

    • form object

      The form that this submission was created for

      Additional properties are allowed.

    • answers array[object]

      The answers to the questions

      Additional properties are allowed.
GET /public-form/form/{form_uuid} 
curl \
 -X GET https://api.plannrcrm.com/public-form/form/form_uuid \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json"
Response examples (200) 
{
  "form": {
    "live": true,
    "uuid": "ff642166-e9e4-4aa4-92d6-6b0d4197bfa9",
    "title": "Annual Catchup 2022",
    "sections": "App\\Http\\Resources\\FormQuestionResource",
    "created_at": "2024-11-20T13:24:05+00:00",
    "updated_at": "2024-11-20T13:24:05+00: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": "132785e5-fd66-48d9-8cbd-b5dd4d2d5de3",
  "stage": "draft",
  "account": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "744ac236-cd7a-4aeb-9ae4-38753e6fe8d0",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-11-20T13:24:05+00:00",
    "first_name": "Gareth",
    "updated_at": "2024-11-20T13:24:05+00:00",
    "with_login": true,
    "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": "2024-11-20T13:24:05+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-11-20T13:24:05+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-11-20T13:24:05+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-11-20T13:24:05+00:00"
  },
  "answers": [
    {
      "last_name": "olive",
      "first_name": "john"
    }
  ],
  "request": {
    "form": "App\\Http\\Resources\\FormResource",
    "uuid": "6d08e5c1-4de3-4155-aa02-51999f22947f",
    "created_at": "2024-11-20T13:24:05+00:00",
    "submission": "App\\Http\\Resources\\FormSubmissionResource",
    "updated_at": "2024-11-20T13:24:05+00:00",
    "description": "Please submit your annual survey form",
    "has_submission": true
  },
  "created_at": "2024-11-20T13:24:05+00:00",
  "updated_at": "2024-11-20T13:24:05+00:00"
}