Get all submissions for a form

GET /api/v1/form/{form_uuid}/submission

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. Example 2022-04-05

  • filter[created_before] string

    Date to filter when the record was created before. Example 2022-05-31

  • filter[stage] string

    Flter 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]

      Additional properties are allowed.
GET /api/v1/form/{form_uuid}/submission 
curl \
 -X GET https://api.plannrcrm.com/api/v1/form/form_uuid/submission \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "form": {
        "live": true,
        "uuid": "a49c28c0-1cb0-4aaf-bf15-746f0ae951fd",
        "title": "Annual Catchup 2022",
        "sections": "App\\Http\\Resources\\FormQuestionResource",
        "created_at": "2025-01-17T11:18:30+00:00",
        "updated_at": "2025-01-17T11:18:30+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": "030836b9-9f5f-46f8-aee7-59992693de8e",
      "stage": "draft",
      "account": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "354ea9d6-0434-4034-a15a-a2684dee80af",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2025-01-17T11:18:30+00:00",
        "first_name": "Gareth",
        "updated_at": "2025-01-17T11:18:30+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": "2025-01-17T11:18:30+00:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2025-01-17T11:18:30+00:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "previous_review_date": "2025-01-17T11:18:30+00:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2025-01-17T11:18:30+00:00"
      },
      "answers": [
        {
          "last_name": "olive",
          "first_name": "john"
        }
      ],
      "request": {
        "form": "App\\Http\\Resources\\FormResource",
        "uuid": "8b4c7f91-862f-4638-a9c0-06b0cdf4cc06",
        "created_at": "2025-01-17T11:18:30+00:00",
        "submission": "App\\Http\\Resources\\FormSubmissionResource",
        "updated_at": "2025-01-17T11:18:30+00:00",
        "description": "Please submit your annual survey form",
        "has_submission": true
      },
      "created_at": "2025-01-17T11:18:30+00:00",
      "updated_at": "2025-01-17T11:18:30+00:00"
    }
  ]
}