Get all fact-find requests for the user.

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

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
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": "e0bc076e-c6bb-41f8-a430-a19c15e8393f",
      "schema": {
        "name": "Default fact-find",
        "uuid": "92e3b3c7-5b45-4ff5-b07b-9eab09381307",
        "created_at": "2025-04-22T13:44:20+01:00",
        "public_url": "https://plannr.valet/fact-find/2552749a-7766-4a0a-bd11-86590b309124",
        "updated_at": "2025-04-22T13:44:20+01:00",
        "archived_at": "2025-04-21T13:44:20+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": "1e960a38-d825-4865-a120-b8d70927f8b1",
        "email": "gareth@codepotato.co.uk",
        "last_name": "Thompson",
        "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
        "created_at": "2025-04-22T13:44:20+01:00",
        "first_name": "Gareth",
        "updated_at": "2025-04-22T13:44:20+01:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
      },
      "created_at": "2025-04-22T13:44:20+01:00",
      "updated_at": "2025-04-22T13:44:20+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": "58043acc-9e4c-4a90-a841-021205222bd4",
        "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": "49f96ea1-2fe4-44f6-b1d1-3719f0055aad"
        },
        "created_at": "2025-04-22T13:44:20+01:00",
        "updated_at": "2025-04-22T13:44:20+01:00",
        "folder_name": "folder 2",
        "uploaded_at": "2025-04-22T13:44:20+01:00",
        "documentable": "Object",
        "download_url": "https://plannr.valet/file/5d9499e1-8361-4fce-9efc-7bc6579d27be/download",
        "last_modified": "2025-04-22T13:44:20+01:00",
        "documentable_type": "account",
        "original_created_at": "2025-04-22T13:44:20+01:00"
      },
      "completed_at": "2025-04-17T13:44:20+01:00",
      "invitation_url": "https://plannr.valet/fact-find/2b34b4b0-64c4-4c18-b577-c9b9d3cb20ab/2a536854-392e-4376-9f7a-077eeecbaf8f",
      "invitation_text": "Please complete this fact-find!",
      "fact_find_passes": {
        "firm": {
          "name": "Codepotato Ltd",
          "uuid": "fa9bceef-6999-47aa-9a90-92159732558d"
        },
        "uuid": "f467ead0-8b7e-40cd-86f8-149087d8ce77",
        "circle": {
          "name": "The Codepotato Gang",
          "uuid": "956ef135-af7b-4dc3-bf8c-b0dd2c1aef27"
        },
        "account": "App\\Http\\Resources\\MinimalAccountResource",
        "progress": 50,
        "created_at": "2025-04-22T13:44:20+01:00",
        "expires_at": "2025-04-22T13:44:20+01:00",
        "updated_at": "2025-04-22T13:44:20+01:00",
        "is_complete": false,
        "completed_sections": 2
      }
    }
  ]
}