Get a fact-find request
Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
Path parameters
-
factFindRequest_uuid
string Required
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": "5422011b-fe5e-4c3f-9fd5-d4453a100bdd",
"schema": {
"name": "Default fact-find",
"uuid": "89b14aaf-6cc0-4eea-b9cd-f208002758d6",
"created_at": "2025-04-22T13:44:20+01:00",
"public_url": "https://plannr.valet/fact-find/dace441d-0f9e-443b-af9b-6f6954912d2c",
"updated_at": "2025-04-22T13:44:20+01:00",
"archived_at": "2025-04-21T13:44:20+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": "88f5fea4-a50e-403b-886b-8a696f2bcdd0",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-04-22T13:44:20+01:00",
"first_name": "Gareth",
"updated_at": "2025-04-22T13:44:20+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"created_at": "2025-04-22T13:44:20+01:00",
"updated_at": "2025-04-22T13:44:20+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": "43c53b64-2538-4e89-94fd-0948a80eceb1",
"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": "da3af406-40d3-45f2-b792-f4b2f77946f0"
},
"created_at": "2025-04-22T13:44:20+01:00",
"updated_at": "2025-04-22T13:44:20+01:00",
"folder_name": "folder 2",
"uploaded_at": "2025-04-22T13:44:20+01:00",
"documentable": "Object",
"download_url": "https://plannr.valet/file/2e7a4fa9-e4e5-4af4-90c5-c579ce5dca8b/download",
"last_modified": "2025-04-22T13:44:20+01:00",
"documentable_type": "account",
"original_created_at": "2025-04-22T13:44:20+01:00"
},
"completed_at": "2025-04-17T13:44:20+01:00",
"invitation_url": "https://plannr.valet/fact-find/f609d27e-d2cd-4143-a62e-2e97357a4924/dd57feed-c848-4328-a2ce-ba54d421b878",
"invitation_text": "Please complete this fact-find!",
"fact_find_passes": {
"firm": {
"name": "Codepotato Ltd",
"uuid": "9a3b37f0-4e9c-44e1-9a9b-165c8c3d28b1"
},
"uuid": "ad6d358d-d2a5-42f9-b63d-a9bb24cfac0b",
"circle": {
"name": "The Codepotato Gang",
"uuid": "e3019e7a-a8ca-4871-a310-2837f65d86df"
},
"account": "App\\Http\\Resources\\MinimalAccountResource",
"progress": 50,
"created_at": "2025-04-22T13:44:20+01:00",
"expires_at": "2025-04-22T13:44:20+01:00",
"updated_at": "2025-04-22T13:44:20+01:00",
"is_complete": false,
"completed_sections": 2
}
}