Get a submission request

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

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 \
 -X GET https://api.plannrcrm.com/api/v1/submission-request/id \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json"
Response examples (200) 
{
  "form": {
    "live": true,
    "uuid": "8ed00abd-5451-456b-9e82-ed0e7bee9ddc",
    "title": "Annual Catchup 2022",
    "sections": "App\\Http\\Resources\\FormQuestionResource",
    "created_at": "2024-11-20T13:24:01+00:00",
    "updated_at": "2024-11-20T13:24:01+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": "c6644518-be4c-4fb5-a070-785b0dbaaa7f",
  "created_at": "2024-11-20T13:24:01+00:00",
  "submission": {
    "form": "App\\Http\\Resources\\FormResource",
    "uuid": "8f370d19-dbeb-4840-9731-7270c759eea0",
    "stage": "draft",
    "account": "App\\Http\\Resources\\AccountResource",
    "answers": [
      {
        "last_name": "olive",
        "first_name": "john"
      }
    ],
    "request": "App\\Http\\Resources\\FormSubmissionRequestResource",
    "created_at": "2024-11-20T13:24:01+00:00",
    "updated_at": "2024-11-20T13:24:01+00:00"
  },
  "updated_at": "2024-11-20T13:24:01+00:00",
  "description": "Please submit your annual survey form",
  "has_submission": true
}