Get a submission

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

Personal access token & OAuth2

Headers

Path parameters

form_uuid integer Required
uuid string Required

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 /api/v1/form/{form_uuid}/submission/{uuid}

curl \
 --request GET https://api.plannrcrm.com/api/v1/form/form_uuid/submission/uuid \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"

Response examples (200)

{
  "form": {
    "live": true,
    "uuid": "6185dd5f-9089-4508-966b-ba7fc17151fc",
    "title": "Annual Catchup 2022",
    "sections": "App\\Http\\Resources\\FormQuestionResource",
    "created_at": "2025-02-20T10:13:03+00:00",
    "updated_at": "2025-02-20T10:13:03+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": "69b74774-e2fe-459d-a7aa-d67cb75fcf57",
  "stage": "draft",
  "account": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "de3eb7a1-799c-4bb7-8371-b4d01ff6da05",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-02-20T10:13:03+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-02-20T10:13:03+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-02-20T10:13:03+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-02-20T10:13:03+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2025-02-20T10:13:03+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-02-20T10:13:03+00:00"
  },
  "answers": [
    {
      "last_name": "olive",
      "first_name": "john"
    }
  ],
  "request": {
    "form": "App\\Http\\Resources\\FormResource",
    "uuid": "79d7470b-13d5-4015-8047-f284158c64a1",
    "created_at": "2025-02-20T10:13:03+00:00",
    "submission": "App\\Http\\Resources\\FormSubmissionResource",
    "updated_at": "2025-02-20T10:13:03+00:00",
    "description": "Please submit your annual survey form",
    "has_submission": true
  },
  "created_at": "2025-02-20T10:13:03+00:00",
  "updated_at": "2025-02-20T10:13:03+00:00"
}