Get a fact-find request

GET /api/v1/fact-find/request/{factFindRequest_uuid}

Personal access token & OAuth2

Headers

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.
  
  Additional properties are allowed.
- latest_file object
  
  The latest file that has been generated for the fact-find request.
  
  Additional properties are allowed.

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": "02aec59e-3b1a-45e0-a5ab-59d4824f86ec",
  "schema": {
    "name": "Default fact-find",
    "uuid": "fc63c219-04ea-4fd5-a0b9-328913c325d7",
    "created_at": "2025-02-20T10:13:05+00:00",
    "updated_at": "2025-02-20T10:13:05+00:00",
    "archived_at": "2025-02-19T10:13:05+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",
  "created_at": "2025-02-20T10:13:05+00:00",
  "updated_at": "2025-02-20T10:13:05+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": "95b3ce1a-24c5-445f-97f9-653abc1f90d7",
    "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": "0816decc-d37a-4550-b561-019b3dd57fce"
    },
    "created_at": "2025-02-20T10:13:05+00:00",
    "updated_at": "2025-02-20T10:13:05+00:00",
    "folder_name": "folder 2",
    "uploaded_at": "2025-02-20T10:13:05+00:00",
    "documentable": "Object",
    "download_url": "https://plannr.valet/file/5d772b4c-d08d-41fa-bd2c-d70dd0a5f3ed/download",
    "last_modified": "2025-02-20T10:13:05+00:00",
    "documentable_type": "account",
    "original_created_at": "2025-02-20T10:13:05+00:00"
  },
  "completed_at": "2025-02-15T10:13:05+00:00",
  "invitation_text": "Please complete this fact-find!"
}