Get a fact-find request

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

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.

    • latest_file object

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

    • account object

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

    • invitation_url string

      The invitation URL sent to the client.

    • fact_find_passes object

      The fact find passes added to the fact-find request.
GET /api/v1/fact-find/request/{factFindRequest_uuid} 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/fact-find/request/factFindRequest_uuid' \
 --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) 
{
  "uuid": "87bb4a7c-4c91-46ea-a19a-99d35861032d",
  "schema": {
    "name": "Default fact-find",
    "uuid": "8fa1acf7-375a-4f96-a93a-8062ea442745",
    "created_at": "2025-04-02T13:27:58+01:00",
    "public_url": "https://plannr.valet/fact-find/18d6fd89-6846-4c26-83fc-5b2d5fe4cec8",
    "updated_at": "2025-04-02T13:27:58+01:00",
    "archived_at": "2025-04-01T13:27:58+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": "13a0d069-a9b8-4bcf-850f-6e7319ab2d40",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2025-04-02T13:27:58+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-04-02T13:27:58+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "created_at": "2025-04-02T13:27:58+01:00",
  "updated_at": "2025-04-02T13:27:58+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": "a38208db-e432-4920-b437-7a696a3aed89",
    "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": "cfe8378c-da6e-4303-a219-75da6a094317"
    },
    "created_at": "2025-04-02T13:27:58+01:00",
    "updated_at": "2025-04-02T13:27:58+01:00",
    "folder_name": "folder 2",
    "uploaded_at": "2025-04-02T13:27:58+01:00",
    "documentable": "Object",
    "download_url": "https://plannr.valet/file/fd5c12b5-7844-40b8-9abd-c5e8c9c5e6f2/download",
    "last_modified": "2025-04-02T13:27:58+01:00",
    "documentable_type": "account",
    "original_created_at": "2025-04-02T13:27:58+01:00"
  },
  "completed_at": "2025-03-28T13:27:58+00:00",
  "invitation_url": "https://plannr.valet/fact-find/e7beb688-588d-48be-9069-132395576ea1/3990ab8c-1de4-4398-a099-507ad0b97539",
  "invitation_text": "Please complete this fact-find!",
  "fact_find_passes": {
    "firm": {
      "name": "Codepotato Ltd",
      "uuid": "b20da0f0-a04c-481d-a8bb-3d24bb969a69"
    },
    "uuid": "e3c78ec8-8f0b-4302-9ab6-56424db44dc1",
    "circle": {
      "name": "The Codepotato Gang",
      "uuid": "ecff06c5-3db4-481a-8a77-1ce4b6c108d4"
    },
    "account": "App\\Http\\Resources\\MinimalAccountResource",
    "progress": 50,
    "created_at": "2025-04-02T13:27:58+01:00",
    "expires_at": "2025-04-02T13:27:58+01:00",
    "updated_at": "2025-04-02T13:27:58+01:00",
    "is_complete": false,
    "completed_sections": 2
  }
}