Get all submission requests on a form

GET /api/v1/submission-request

This endpoint can only be hit by senior employees It will show every form submission request created for this form Including whom sent the request and the recipient

Headers

X-PLANNR-ACCOUNT-UUID string

Query parameters

filter[uuid] string

Filter by a comma separated list of UUIDs.
filter[created_after] string

Date to filter when the record was created after.
filter[created_before] string

Date to filter when the record was created before.
filter[form.title] string

@deprecated Please use filter[form_title] instead.
filter[form_title] string

Filter by partial form titles.
filter[sender_uuids] string

Filter by a comma separated list of employee account UUIDs of who sent the form requests.
filter[receiver_uuids] string

Filter by a comma separated list of client account UUIDs of who received the form requests.
filter[circle_uuids] string

Filter by a comma separated list of circle UUIDs belonging to client accounts of who received the form requests.
sort string

Field to sort by. Valid fields are [created_at, updated_at, description]. 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]
  
  Hide data attributes Show data attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  description string
  
  form object
  
  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
  
  submission object
  
  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

curl \
 --request GET 'https://api.plannrcrm.com/api/v1/submission-request' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"

Response examples (200)

{
  "data": [
    {
      "form": {
        "live": true,
        "uuid": "9ccdaf04-1792-47b0-aa53-02d3c80676dc",
        "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": "eac9fb4c-0ee8-4656-bf6f-e5debfdacc2f",
      "created_at": "2025-06-25T15:10:43+01:00",
      "submission": {
        "form": "App\\Http\\Resources\\FormResource",
        "uuid": "03491a8e-e396-4423-9813-41166522fc2a",
        "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
    }
  ]
}