Get all fact-find requests the client owns.

GET /api/v1/client/{client_id}/fact-find/requests

Path parameters

Query parameters

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • sort string

    Field to sort by. Valid fields are [created_at, updated_at]. 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/client/{client_id}/fact-find/requests 
curl \
 -X GET https://api.plannrcrm.com/api/v1/client/client_id/fact-find/requests \
 -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": [
    {
      "uuid": "73956e94-ba15-4553-9155-855b8c585cdb",
      "schema": {
        "name": "Default fact-find",
        "uuid": "58446dce-9b8b-4b77-b668-bac3c0497137",
        "created_at": "2024-11-20T13:24:00+00:00",
        "updated_at": "2024-11-20T13:24:00+00:00",
        "archived_at": "2024-11-19T13:24:00+00:00",
        "is_archived": false,
        "sections_count": 5,
        "introduction_html": "Welcome to our fact-find! <b>You can use some HTML too.</b>"
      },
      "status": "complete",
      "created_at": "2024-11-20T13:24:00+00:00",
      "updated_at": "2024-11-20T13:24:00+00:00",
      "latest_file": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Welcome to Plannr",
        "size": "21691783",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "type",
        "uuid": "76463fe3-af26-466b-b6a6-7fa103d56d05",
        "parent": "Object",
        "status": "uploaded",
        "account": "App\\Http\\Resources\\AccountResource",
        "filename": "Welcome to Plannr.pdf",
        "progress": "100",
        "extension": "pdf",
        "created_at": "2024-11-20T13:24:00+00:00",
        "updated_at": "2024-11-20T13:24:00+00:00",
        "folder_name": "folder 2",
        "uploaded_at": "2024-11-20T13:24:00+00:00",
        "download_url": "https://plannr.valet/file/c31ae580-7e69-44c5-9e93-458b6bbcb264/download",
        "last_modified": "2024-11-20T13:24:00+00:00",
        "original_created_at": "2024-11-20T13:24:00+00:00"
      },
      "completed_at": "2024-11-15T13:24:00+00:00",
      "invitation_text": "Please complete this fact-find!"
    }
  ]
}