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

Headers

  • X-PLANNR-ACCOUNT-UUID string

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]
      Hide data attributes Show data 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 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/fact-find/request' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "uuid": "6205129e-6075-4390-80a3-4a478784ade4",
      "schema": {
        "name": "Default fact-find",
        "uuid": "cccffde8-c33a-415b-b848-d7e2ad18f308",
        "created_at": "2025-12-24T11:03:00+00:00",
        "public_url": "https://api.plannrcrm.com/fact-find/e4b51732-2e36-4738-88a6-a38947af5aae",
        "updated_at": "2025-12-24T11:03:00+00:00",
        "archived_at": "2025-12-23T11:03:00+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": "cdfd86f8-769c-46e5-8d40-a1d007afd268",
        "email": "gareth@codepotato.co.uk",
        "last_name": "Thompson",
        "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
        "created_at": "2025-12-24T11:03:00+00:00",
        "first_name": "Gareth",
        "updated_at": "2025-12-24T11:03:00+00:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
      },
      "created_at": "2025-12-24T11:03:00+00:00",
      "updated_at": "2025-12-24T11:03:00+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": "a1d922a7-e7e2-4f74-9217-1f53e64f24be",
        "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": "0fd319f8-ac9b-4e2d-944a-18be72d13bff"
        },
        "created_at": "2025-12-24T11:03:00+00:00",
        "updated_at": "2025-12-24T11:03:00+00:00",
        "folder_name": "folder 2",
        "uploaded_at": "2025-12-24T11:03:00+00:00",
        "documentable": "Object",
        "download_url": "https://api.plannrcrm.com/file/6ea98d21-43c1-441e-8204-8d91f02b6fe6/download",
        "last_modified": "2025-12-24T11:03:00+00:00",
        "documentable_type": "account",
        "original_created_at": "2025-12-24T11:03:00+00:00"
      },
      "completed_at": "2025-12-19T11:03:00+00:00",
      "invitation_url": "https://api.plannrcrm.com/fact-find/edecb205-e1fa-455f-aede-350aec6515cd/e6482fee-5154-4826-89af-39701468aaf8",
      "invitation_text": "Please complete this fact-find!",
      "fact_find_passes": {
        "firm": {
          "name": "Codepotato Ltd",
          "uuid": "7ebc3bff-d46d-4598-b188-ca88462334b8"
        },
        "uuid": "34d80a4a-2bba-43cc-bb79-5bb67d051ed4",
        "circle": {
          "name": "The Codepotato Gang",
          "uuid": "a7f259da-35f3-4449-8e7f-25bf82836806"
        },
        "account": "App\\Http\\Resources\\MinimalAccountResource",
        "progress": 50,
        "created_at": "2025-12-24T11:03:00+00:00",
        "expires_at": "2025-12-24T11:03:00+00:00",
        "updated_at": "2025-12-24T11:03:00+00:00",
        "is_complete": false,
        "completed_sections": 2
      }
    }
  ]
}