Get all submissions for a form

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

Headers

Path parameters

form_uuid integer 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. Example 2022-04-05
filter[created_before] string

Date to filter when the record was created before. Example 2022-05-31
filter[form.title] string

filter title of the form
filter[stage] string

filter submissions by their stage
filter[account] string

name of the account to filter by
filter[hide_null_accounts] boolean

hide null accounts
sort string

Field to sort by. Valid fields are [created_at, updated_at, title]. 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]

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": "aa911039-48aa-425e-b060-43bddafea522",
        "title": "Annual Catchup 2022",
        "sections": "App\\Http\\Resources\\FormQuestionResource",
        "created_at": "2024-10-16T11:10:14+01:00",
        "updated_at": "2024-10-16T11:10:14+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": "7484e26b-3a2c-4197-a07d-e1d104ea93de",
      "stage": "draft",
      "account": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "7cac51df-671c-45f6-8050-8349087730c8",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2024-10-16T11:10:14+01:00",
        "first_name": "Gareth",
        "updated_at": "2024-10-16T11:10:14+01: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-10-16T11:10:14+01:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2024-10-16T11:10:14+01:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "previous_review_date": "2024-10-16T11:10:14+01:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2024-10-16T11:10:14+01:00"
      },
      "answers": [
        {
          "last_name": "olive",
          "first_name": "john"
        }
      ],
      "request": {
        "form": "App\\Http\\Resources\\FormResource",
        "uuid": "4f5193ed-765a-45ba-8fb4-ff27faf4b0ea",
        "created_at": "2024-10-16T11:10:14+01:00",
        "submission": "App\\Http\\Resources\\FormSubmissionResource",
        "updated_at": "2024-10-16T11:10:14+01:00",
        "description": "Please submit your annual survey form",
        "has_submission": true
      },
      "created_at": "2024-10-16T11:10:14+01:00",
      "updated_at": "2024-10-16T11:10:14+01:00"
    }
  ]
}