Get all submission requests on a form

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

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. Example 2022-04-05

  • filter[created_before] string

    Date to filter when the record was created before. Example 2022-05-31

  • 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]

      Additional properties are allowed.
GET /api/v1/form/{form_uuid}/submission-request 
curl \
 -X GET https://api.plannrcrm.com/api/v1/form/form_uuid/submission-request \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "form": {
        "live": true,
        "uuid": "8ef1fa83-3097-4591-a2ac-9cb7fd0bdb75",
        "title": "Annual Catchup 2022",
        "sections": "App\\Http\\Resources\\FormQuestionResource",
        "created_at": "2025-01-17T11:18:30+00:00",
        "updated_at": "2025-01-17T11:18:30+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": "14efd800-6d83-4ea3-8e66-032852b37e99",
      "created_at": "2025-01-17T11:18:30+00:00",
      "submission": {
        "form": "App\\Http\\Resources\\FormResource",
        "uuid": "da1da071-56a0-45d2-98dd-d7471fe219b2",
        "stage": "draft",
        "account": "App\\Http\\Resources\\AccountResource",
        "answers": [
          {
            "last_name": "olive",
            "first_name": "john"
          }
        ],
        "request": "App\\Http\\Resources\\FormSubmissionRequestResource",
        "created_at": "2025-01-17T11:18:30+00:00",
        "updated_at": "2025-01-17T11:18:30+00:00"
      },
      "updated_at": "2025-01-17T11:18:30+00:00",
      "description": "Please submit your annual survey form",
      "has_submission": true
    }
  ]
}