Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • form_uuid string Required

Query parameters

  • include string

    Comma separated list of relationships to include in the response. Valid relationships are [account]

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • filter[created_after] string

    Date to filter when the record was created after.

  • filter[created_before] string

    Date to filter when the record was created before.

  • filter[stage] string

    Filter submissions by their stage. Valid options are draft,submitted,approved,changes_requested.

  • filter[account] string

    Name of the account of who the submission was against.

  • filter[account_uuids] string

    Filter by a comma separated list of accounts UUIDs of who the form was submitted against.

  • filter[submitted_by_uuid] string

    Filter by a comma separated list of account UUIDs of who submitted the form.

  • filter[circle_uuids] string

    Filter by a comma separated list of circle UUIDs belonging to accounts of who the form was submitted against.

  • filter[hide_null_accounts] boolean

    Hide form submissions that are not linked to an account, this could be submissions on public forms.

  • sort string

    Field to sort by. Valid fields are [created_at, updated_at, stage]. Negative sign to denote DESC. Defaults to '-created_at'.

  • per_page integer

    Number of results to return with pagination (Default 15. Max 500).

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • data array[object]
      Hide data attributes Show data attributes object
      • uuid string
      • created_at string
      • updated_at string
      • stage string
      • account object
        Hide account attributes Show account attributes object
        • uuid string
        • created_at string
        • updated_at string
        • type string
        • role string
        • first_name string
        • last_name string
        • name string
        • email string
        • photo_url string
        • firm string
        • primary_phone_number string
        • primary_email string
        • current_time_entry string
        • assigned_adviser string
        • assigned_administrator string
        • assigned_paraplanner string
        • introduced_by string
        • groups string
        • tags string
        • owners string
        • first_contact_date string
        • next_review_date string
        • previous_review_date string
        • anniversary_review_date string
        • with_login boolean
        • has_joint_account boolean
        • can_be_deleted string
        • joint_account_circle string
        • circles string
        • ownership_percentage integer
        • inactive_at string
        • last_interaction_at string
        • custom_fields string
        • external_references string
      • request object
        Hide request attributes Show request attributes object
        • uuid string
        • created_at string
        • updated_at string
        • description string
        • form string
        • has_submission boolean
        • submission string
      • form object
        Hide form attributes Show form attributes object
        • uuid string
        • created_at string
        • updated_at string
        • title string
        • description string
        • live boolean
        • visibility string
        • sections string
        • allowed_hosts array[string]
        • draft_submissions_count integer
        • submitted_submissions_count integer
        • create_client boolean
        • client_type string
      • answers array[object]
        Hide answers attributes Show answers attributes object
        • first_name string
        • last_name string
GET /api/v1/form/{form_uuid}/submission
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/form/6ff8f7f6-1eb3-3525-be4a-3932c805afed/submission' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
  "data": [
    [
      {
        "form": {
          "live": true,
          "uuid": "3fdf9fb7-3328-4236-8b08-11c19cdfe1f9",
          "title": "Annual Catchup 2022",
          "sections": "App\\Http\\Resources\\FormQuestionResource",
          "created_at": "2025-12-24T11:02:59+00:00",
          "updated_at": "2025-12-24T11:02:59+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": "6f043030-157c-4980-b9ce-76b0a27fcf3d",
        "stage": "draft",
        "account": {
          "firm": "App\\Http\\Resources\\FirmResource",
          "name": "Gareth Thompson",
          "role": "client",
          "tags": "App\\Http\\Resources\\TagResource",
          "type": "client",
          "uuid": "71da08e7-c820-4e9b-be7c-7fe9d8ee5e36",
          "email": "gareth@codepotato.co.uk",
          "groups": "App\\Http\\Resources\\GroupResource",
          "owners": "App\\Http\\Resources\\AccountResource",
          "circles": "App\\Http\\Resources\\CircleResource",
          "last_name": "Thompson",
          "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
          "created_at": "2025-12-24T11:02:59+00:00",
          "first_name": "Gareth",
          "updated_at": "2025-12-24T11:02:59+00:00",
          "with_login": true,
          "inactive_at": "2025-12-24",
          "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-12-24T11:02:59+00:00",
          "has_joint_account": true,
          "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
          "first_contact_date": "2025-12-24T11:02:59+00:00",
          "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
          "last_interaction_at": "2025-12-24 11:02:59",
          "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
          "joint_account_circle": "App\\Http\\Resources\\CircleResource",
          "ownership_percentage": 100,
          "previous_review_date": "2025-12-24T11:02:59+00:00",
          "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
          "assigned_administrator": "App\\Http\\Resources\\AccountResource",
          "anniversary_review_date": "2025-12-24T11:02:59+00:00"
        },
        "answers": [
          {
            "last_name": "olive",
            "first_name": "john"
          }
        ],
        "request": {
          "form": "App\\Http\\Resources\\FormResource",
          "uuid": "213c0c6c-d926-4afa-b307-da1fd43a15bc",
          "created_at": "2025-12-24T11:02:59+00:00",
          "submission": "App\\Http\\Resources\\FormSubmissionResource",
          "updated_at": "2025-12-24T11:02:59+00:00",
          "description": "Please submit your annual survey form",
          "has_submission": true
        },
        "created_at": "2025-12-24T11:02:59+00:00",
        "updated_at": "2025-12-24T11:02:59+00:00"
      }
    ]
  ]
}