Get all fact-find requests for the user.

GET /api/v1/fact-find/request
Personal access token & OAuth2

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/fact-find/request 
curl \
 --request GET https://api.plannrcrm.com/api/v1/fact-find/request \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "uuid": "610d364c-4f64-4058-9a9b-d032a250130d",
      "schema": {
        "name": "Default fact-find",
        "uuid": "c8cf0df5-1947-4d7f-8318-71c25f480f50",
        "created_at": "2025-02-20T10:13:05+00:00",
        "updated_at": "2025-02-20T10:13:05+00:00",
        "archived_at": "2025-02-19T10:13:05+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": "2025-02-20T10:13:05+00:00",
      "updated_at": "2025-02-20T10:13:05+00:00",
      "latest_file": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Welcome to Plannr",
        "path": "Gareth Thompson/Subfolder/Welcome to Plannr.pdf",
        "size": "21691783",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "type",
        "uuid": "fffc978a-8117-4205-adcf-f21384fb9faf",
        "folder": "App\\Http\\Resources\\FolderResource",
        "status": "uploaded",
        "account": "App\\Http\\Resources\\MinimalAccountResource",
        "filename": "Welcome to Plannr.pdf",
        "progress": "100",
        "extension": "pdf",
        "navigator": {
          "model_type": "account",
          "model_uuid": "57224ebf-9c0a-477f-b953-5489d666a3e1"
        },
        "created_at": "2025-02-20T10:13:05+00:00",
        "updated_at": "2025-02-20T10:13:05+00:00",
        "folder_name": "folder 2",
        "uploaded_at": "2025-02-20T10:13:05+00:00",
        "documentable": "Object",
        "download_url": "https://plannr.valet/file/9d5b3665-4663-476a-b3c0-3ae416f5a5bd/download",
        "last_modified": "2025-02-20T10:13:05+00:00",
        "documentable_type": "account",
        "original_created_at": "2025-02-20T10:13:05+00:00"
      },
      "completed_at": "2025-02-15T10:13:05+00:00",
      "invitation_text": "Please complete this fact-find!"
    }
  ]
}