Get a submission request

GET /api/v1/submission-request/{uuid}

Path parameters

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.
- description string
  
  The description of the form submission request
- form object
  
  The form linked to this submission request
  
  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
- has_submission boolean
  
  Denotes if this request has a submission stored against it
- submission object
  
  The submission stored against this request
  
  Hide submission attributes Show submission attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  stage string
  
  account string
  
  request string
  
  form string
  
  answers array[object]
  
  Hide answers attributes Show answers attributes object
  
  first_name string
  
  last_name string

GET /api/v1/submission-request/{uuid}

curl \
 --request GET 'https://api.plannrcrm.com/api/v1/submission-request/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "form": {
    "live": true,
    "uuid": "91dab750-0fac-49a0-bdd3-b703fbd5a394",
    "title": "Annual Catchup 2022",
    "sections": "App\\Http\\Resources\\FormQuestionResource",
    "created_at": "2025-06-25T15:10:43+01:00",
    "updated_at": "2025-06-25T15:10:43+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": "e7036507-38ed-491d-9175-5e0988d271a9",
  "created_at": "2025-06-25T15:10:43+01:00",
  "submission": {
    "form": "App\\Http\\Resources\\FormResource",
    "uuid": "aeaf9939-0f4e-46d2-9c3e-88a41535f7ae",
    "stage": "draft",
    "account": "App\\Http\\Resources\\AccountResource",
    "answers": [
      {
        "last_name": "olive",
        "first_name": "john"
      }
    ],
    "request": "App\\Http\\Resources\\FormSubmissionRequestResource",
    "created_at": "2025-06-25T15:10:43+01:00",
    "updated_at": "2025-06-25T15:10:43+01:00"
  },
  "updated_at": "2025-06-25T15:10:43+01:00",
  "description": "Please submit your annual survey form",
  "has_submission": true
}