Query parameters

  • 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
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": "e052f78c-826d-4d9e-8332-500f3c27654d",
      "schema": {
        "name": "Default fact-find",
        "uuid": "0a8495a2-a395-498d-8318-16d60496770b",
        "created_at": "2025-06-05T11:39:42+01:00",
        "public_url": "https://plannr.valet/fact-find/e44f40c9-8267-4537-a9ec-0e73301dc89f",
        "updated_at": "2025-06-05T11:39:42+01:00",
        "archived_at": "2025-06-04T11:39:42+01:00",
        "is_archived": false,
        "sections_count": 5,
        "introduction_html": "Welcome to our fact-find! <b>You can use some HTML too.</b>"
      },
      "status": "complete",
      "account": {
        "name": "Gareth Thompson",
        "role": "client",
        "type": "client",
        "uuid": "68369f5a-80d0-4f51-8e36-b886815dea5a",
        "email": "gareth@codepotato.co.uk",
        "last_name": "Thompson",
        "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
        "created_at": "2025-06-05T11:39:42+01:00",
        "first_name": "Gareth",
        "updated_at": "2025-06-05T11:39:42+01:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
      },
      "created_at": "2025-06-05T11:39:42+01:00",
      "updated_at": "2025-06-05T11:39:42+01: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": "8281ab44-b6b6-4b1b-bf8c-36a1376a980f",
        "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": "8e4e9356-7552-4ac5-81fa-23c72f144c5b"
        },
        "created_at": "2025-06-05T11:39:42+01:00",
        "updated_at": "2025-06-05T11:39:42+01:00",
        "folder_name": "folder 2",
        "uploaded_at": "2025-06-05T11:39:42+01:00",
        "documentable": "Object",
        "download_url": "https://plannr.valet/file/0f88c89a-4e83-421b-a801-0787c4291f9f/download",
        "last_modified": "2025-06-05T11:39:42+01:00",
        "documentable_type": "account",
        "original_created_at": "2025-06-05T11:39:42+01:00"
      },
      "completed_at": "2025-05-31T11:39:42+01:00",
      "invitation_url": "https://plannr.valet/fact-find/91d2eb4c-609d-446d-ad23-ee928abccc5a/7c7708c6-7565-4c76-861f-670fe9fdba79",
      "invitation_text": "Please complete this fact-find!",
      "fact_find_passes": {
        "firm": {
          "name": "Codepotato Ltd",
          "uuid": "80e79ddb-41f4-4041-bfee-79d56de3674f"
        },
        "uuid": "835ef29f-0227-4713-98c8-3c1130377756",
        "circle": {
          "name": "The Codepotato Gang",
          "uuid": "bb969563-9aa8-4a6e-b633-6cc53e706a0f"
        },
        "account": "App\\Http\\Resources\\MinimalAccountResource",
        "progress": 50,
        "created_at": "2025-06-05T11:39:42+01:00",
        "expires_at": "2025-06-05T11:39:42+01:00",
        "updated_at": "2025-06-05T11:39:42+01:00",
        "is_complete": false,
        "completed_sections": 2
      }
    }
  ]
}