Get all received form submission requests

GET /api/v1/submission-request/received/{account}
Personal access token & O auth2

Get all form submission requests that were received by the authhenticated account, or by the account given in the URL.

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
GET /api/v1/submission-request/received/{account} 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/submission-request/received/account' \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json"
Response examples (200) 
{
  "data": [
    {
      "form": {
        "live": true,
        "uuid": "01a2d029-3273-490d-a5fd-c2c8de06418b",
        "title": "Annual Catchup 2022",
        "sections": "App\\Http\\Resources\\FormQuestionResource",
        "created_at": "2025-04-02T13:27:56+01:00",
        "updated_at": "2025-04-02T13:27:56+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": "cfbd728e-ce67-4eec-9a96-e3c1b75dc832",
      "created_at": "2025-04-02T13:27:56+01:00",
      "submission": {
        "form": "App\\Http\\Resources\\FormResource",
        "uuid": "22acc341-7474-4c58-8e97-2b1b99dd795c",
        "stage": "draft",
        "account": "App\\Http\\Resources\\AccountResource",
        "answers": [
          {
            "last_name": "olive",
            "first_name": "john"
          }
        ],
        "request": "App\\Http\\Resources\\FormSubmissionRequestResource",
        "created_at": "2025-04-02T13:27:56+01:00",
        "updated_at": "2025-04-02T13:27:56+01:00"
      },
      "updated_at": "2025-04-02T13:27:56+01:00",
      "description": "Please submit your annual survey form",
      "has_submission": true
    }
  ]
}