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

Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • factFindRequest_uuid string Required

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • uuid string

      The UUID of the resource.

    • created_at string

      The timestamp of when the resource was created.

    • updated_at string

      The timestamp of when the resource was updated.

    • status string

      The status of the fact-find request. Available options: in_progress,complete

    • completed_at string

      The datetime when the fact-find request has been completed

    • invitation_text string

      The text that is used in the notification/email sent out to the client.

    • schema object

      The fact-find schema used for the fact-find request.

      Hide schema attributes Show schema attributes object
      • uuid string
      • created_at string
      • updated_at string
      • archived_at string
      • is_archived boolean
      • name string
      • introduction_html string
      • sections_count integer
      • public_url string
    • latest_file object

      The latest file that has been generated for the fact-find request.

      Hide latest_file attributes Show latest_file attributes object
      • uuid string
      • created_at string
      • original_created_at string
      • updated_at string
      • uploaded_at string
      • status string
      • filename string
      • name string
      • extension string
      • type string
      • size string
      • path string
      • last_modified string
      • progress string
      • download_url string
      • folder_name string
      • folder string
      • documentable_type string
      • documentable string
      • navigator object
        Hide navigator attributes Show navigator attributes object
        • model_type string
        • model_uuid string
      • firm string
      • account string
      • tags string
    • account object

      The account that the fact-find request was sent to. Only visible when listing fact-find requests for a circle.

      Hide account attributes Show account attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url string
      • external_references string
    • invitation_url string

      The invitation URL sent to the client.

    • fact_find_passes object

      The fact find passes added to the fact-find request.

      Hide fact_find_passes attributes Show fact_find_passes attributes object
      • uuid string
      • created_at string
      • updated_at string
      • firm object
        Hide firm attributes Show firm attributes object
        • uuid string
        • name string
      • account string
      • circle object
        Hide circle attributes Show circle attributes object
        • uuid string
        • name string
      • expires_at string
      • progress integer
      • is_complete boolean
      • completed_sections integer
GET /api/v1/fact-find/request/{factFindRequest_uuid} 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/fact-find/request/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "uuid": "14037892-b383-4542-a55a-05a9b74c9ffb",
  "schema": {
    "name": "Default fact-find",
    "uuid": "f65f4446-038b-4ecd-ae53-016647e9438d",
    "created_at": "2025-12-04T22:09:16+00:00",
    "public_url": "https://api.plannrcrm.com/fact-find/f99eef57-82f0-4291-a48d-570cb16a22d6",
    "updated_at": "2025-12-04T22:09:16+00:00",
    "archived_at": "2025-12-03T22:09:16+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",
  "account": {
    "name": "Gareth Thompson",
    "role": "client",
    "type": "client",
    "uuid": "1abf3ecb-8893-4054-874b-d2600d72a04d",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2025-12-04T22:09:16+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-12-04T22:09:16+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "created_at": "2025-12-04T22:09:16+00:00",
  "updated_at": "2025-12-04T22:09:16+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": "18e6e57a-d9b1-453e-8c5f-fb4184fafd4c",
    "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": "9307ab0d-8a55-4e5d-93f5-1264502d68ce"
    },
    "created_at": "2025-12-04T22:09:16+00:00",
    "updated_at": "2025-12-04T22:09:16+00:00",
    "folder_name": "folder 2",
    "uploaded_at": "2025-12-04T22:09:16+00:00",
    "documentable": "Object",
    "download_url": "https://api.plannrcrm.com/file/94716dad-7ca4-42fd-ba5d-ff77f35565a5/download",
    "last_modified": "2025-12-04T22:09:16+00:00",
    "documentable_type": "account",
    "original_created_at": "2025-12-04T22:09:16+00:00"
  },
  "completed_at": "2025-11-29T22:09:16+00:00",
  "invitation_url": "https://api.plannrcrm.com/fact-find/3fd659ee-0dc1-4653-ad34-ab37cc6c0efc/3010f759-1033-4ac4-ae96-e23d3f9a7eb2",
  "invitation_text": "Please complete this fact-find!",
  "fact_find_passes": {
    "firm": {
      "name": "Codepotato Ltd",
      "uuid": "3918b3fa-ec2e-412b-a89a-dbeab1decc3b"
    },
    "uuid": "aba3c5e6-82ff-4054-8871-fd2d3abf9f3f",
    "circle": {
      "name": "The Codepotato Gang",
      "uuid": "ed0deb67-fa4a-4b08-b7fc-2f56f4ecdacb"
    },
    "account": "App\\Http\\Resources\\MinimalAccountResource",
    "progress": 50,
    "created_at": "2025-12-04T22:09:16+00:00",
    "expires_at": "2025-12-04T22:09:16+00:00",
    "updated_at": "2025-12-04T22:09:16+00:00",
    "is_complete": false,
    "completed_sections": 2
  }
}