Get a submission request

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

Personal access token & OAuth2

Headers

Authorization string
Content-Type string
Accept string

Path parameters

id string Required

The ID of the submission request.

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
  
  Additional properties are allowed.
- has_submission boolean
  
  Denotes if this request has a submission stored against it
- submission object
  
  The submission stored against this request
  
  Additional properties are allowed.

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

curl \
 --request GET https://api.plannrcrm.com/api/v1/submission-request/id \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json"

Response examples (200)

{
  "form": {
    "live": true,
    "uuid": "685deeeb-1c28-4da5-86d7-a2918209f8f4",
    "title": "Annual Catchup 2022",
    "sections": "App\\Http\\Resources\\FormQuestionResource",
    "created_at": "2025-02-20T10:13:02+00:00",
    "updated_at": "2025-02-20T10:13:02+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": "06a0bf86-906c-4c19-b541-6eb9cb1476bd",
  "created_at": "2025-02-20T10:13:02+00:00",
  "submission": {
    "form": "App\\Http\\Resources\\FormResource",
    "uuid": "11c55a4f-acd1-4fcd-8033-952522a5d91b",
    "stage": "draft",
    "account": "App\\Http\\Resources\\AccountResource",
    "answers": [
      {
        "last_name": "olive",
        "first_name": "john"
      }
    ],
    "request": "App\\Http\\Resources\\FormSubmissionRequestResource",
    "created_at": "2025-02-20T10:13:02+00:00",
    "updated_at": "2025-02-20T10:13:02+00:00"
  },
  "updated_at": "2025-02-20T10:13:02+00:00",
  "description": "Please submit your annual survey form",
  "has_submission": true
}