Get all fact-find requests the client owns.

GET /api/v1/client/{client_id}/fact-find/requests
Personal access token & OAuth2

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 \
 --request GET https://api.plannrcrm.com/api/v1/client/client_id/fact-find/requests \
 --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": "ea9baaa9-131c-483f-ade7-70a0a6264d38",
      "schema": {
        "name": "Default fact-find",
        "uuid": "51c817e5-5630-4228-85b4-3105ed0a229c",
        "created_at": "2025-02-20T10:13:02+00:00",
        "updated_at": "2025-02-20T10:13:02+00:00",
        "archived_at": "2025-02-19T10:13:02+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:02+00:00",
      "updated_at": "2025-02-20T10:13:02+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": "9392a9aa-8c69-4518-abb2-aa2257f87e5d",
        "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": "60a411f5-1a16-4259-9ea7-b3cedd92f77e"
        },
        "created_at": "2025-02-20T10:13:02+00:00",
        "updated_at": "2025-02-20T10:13:02+00:00",
        "folder_name": "folder 2",
        "uploaded_at": "2025-02-20T10:13:02+00:00",
        "documentable": "Object",
        "download_url": "https://plannr.valet/file/1ffb64e4-7bfb-440e-a603-b821ece58f02/download",
        "last_modified": "2025-02-20T10:13:02+00:00",
        "documentable_type": "account",
        "original_created_at": "2025-02-20T10:13:02+00:00"
      },
      "completed_at": "2025-02-15T10:13:02+00:00",
      "invitation_text": "Please complete this fact-find!"
    }
  ]
}