Body
Required
-
The UUID of the fact-find schema that you would like the client to use.
-
The UUID of the client account to send the fact-find request. This must only be individual clients. Cannot be used with circle_uuid.
-
The UUID of the circle to send the fact-find request to. Cannot be used with client_uuid.
-
This controls if an email to the client is sent to invite them to complete a fact-find. Set this to false if you are going to send your own invitation.
-
The text that will appear in the invitation email sent to the client (if enabled)
POST
/api/v1/fact-find/request
curl \
--request POST 'https://api.plannrcrm.com/api/v1/fact-find/request' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
--data '{"fact_find_schema_uuid":"f7243994-4410-4f9b-958e-fc24291828e5","client_uuid":"db939005-a241-4910-9633-2dd71246ec47","circle_uuid":"958cd128-66fb-489b-902e-8edc454f798f","send_invitation_email":true,"invitation_text":"Please complete this fact-find."}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}
# Payload
{
"fact_find_schema_uuid": "f7243994-4410-4f9b-958e-fc24291828e5",
"client_uuid": "db939005-a241-4910-9633-2dd71246ec47",
"circle_uuid": "958cd128-66fb-489b-902e-8edc454f798f",
"send_invitation_email": true,
"invitation_text": "Please complete this fact-find."
}
Response examples (201)
{
"uuid": "9c6f2f6d-ce82-4baf-bf41-f4fb4d05ead3",
"schema": {
"name": "Default fact-find",
"uuid": "6de534f9-d799-417f-9b3f-0470d9c67930",
"created_at": "2025-08-07T13:41:45+01:00",
"public_url": "https://api.plannrcrm.com/fact-find/a50e0691-d790-4309-9246-48b2a476bb23",
"updated_at": "2025-08-07T13:41:45+01:00",
"archived_at": "2025-08-06T13:41:45+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": "5913587c-f997-4c5e-9c1b-a905840ec33d",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-08-07T13:41:45+01:00",
"first_name": "Gareth",
"updated_at": "2025-08-07T13:41:45+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"created_at": "2025-08-07T13:41:45+01:00",
"updated_at": "2025-08-07T13:41:45+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": "14be4d2d-4f62-4930-b50e-9984dc085178",
"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": "dc920906-fd86-4290-b26f-0acf034032bc"
},
"created_at": "2025-08-07T13:41:45+01:00",
"updated_at": "2025-08-07T13:41:45+01:00",
"folder_name": "folder 2",
"uploaded_at": "2025-08-07T13:41:45+01:00",
"documentable": "Object",
"download_url": "https://api.plannrcrm.com/file/9c3231c9-40a0-4aea-89bc-06ab0f8086fd/download",
"last_modified": "2025-08-07T13:41:45+01:00",
"documentable_type": "account",
"original_created_at": "2025-08-07T13:41:45+01:00"
},
"completed_at": "2025-08-02T13:41:45+01:00",
"invitation_url": "https://api.plannrcrm.com/fact-find/f127299a-ba22-45c8-b77c-6c5f1412d1bb/fbf21072-25db-4098-b197-6ff4680308f9",
"invitation_text": "Please complete this fact-find!",
"fact_find_passes": {
"firm": {
"name": "Codepotato Ltd",
"uuid": "86709a24-40a5-49be-9f14-d64ab807374a"
},
"uuid": "df5299ff-66dd-4b86-916b-ccea3b2fd6b2",
"circle": {
"name": "The Codepotato Gang",
"uuid": "c2010c0c-bb7d-4f48-8c87-09ae5bd31e4c"
},
"account": "App\\Http\\Resources\\MinimalAccountResource",
"progress": 50,
"created_at": "2025-08-07T13:41:45+01:00",
"expires_at": "2025-08-07T13:41:45+01:00",
"updated_at": "2025-08-07T13:41:45+01:00",
"is_complete": false,
"completed_sections": 2
}
}