Get a fact-find request

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

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 \
 -X GET https://api.plannrcrm.com/api/v1/fact-find/request/factFindRequest_uuid \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "uuid": "5d01e0e1-6432-4538-a8f2-613a1c138782",
  "schema": {
    "name": "Default fact-find",
    "uuid": "08cd97cd-25dc-48e5-82b4-4a1cfb8c3ccf",
    "created_at": "2024-11-20T13:24:03+00:00",
    "updated_at": "2024-11-20T13:24:03+00:00",
    "archived_at": "2024-11-19T13:24:03+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": "2024-11-20T13:24:03+00:00",
  "updated_at": "2024-11-20T13:24:03+00:00",
  "latest_file": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Welcome to Plannr",
    "size": "21691783",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "type",
    "uuid": "54ad625a-a8a2-45f6-8e00-533dc241a8c1",
    "parent": "Object",
    "status": "uploaded",
    "account": "App\\Http\\Resources\\AccountResource",
    "filename": "Welcome to Plannr.pdf",
    "progress": "100",
    "extension": "pdf",
    "created_at": "2024-11-20T13:24:03+00:00",
    "updated_at": "2024-11-20T13:24:03+00:00",
    "folder_name": "folder 2",
    "uploaded_at": "2024-11-20T13:24:03+00:00",
    "download_url": "https://plannr.valet/file/d8d69b72-5a07-4f10-a632-30ec6629c2f7/download",
    "last_modified": "2024-11-20T13:24:03+00:00",
    "original_created_at": "2024-11-20T13:24:03+00:00"
  },
  "completed_at": "2024-11-15T13:24:03+00:00",
  "invitation_text": "Please complete this fact-find!"
}