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":"badba68f-04b1-422c-90ea-c89a01b3df1e","client_uuid":"549cea69-a06b-4abd-99c7-7dfb6604e7a4","circle_uuid":"37cd537f-9d86-4d97-a255-e6f3ecb133d5","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": "badba68f-04b1-422c-90ea-c89a01b3df1e",
"client_uuid": "549cea69-a06b-4abd-99c7-7dfb6604e7a4",
"circle_uuid": "37cd537f-9d86-4d97-a255-e6f3ecb133d5",
"send_invitation_email": true,
"invitation_text": "Please complete this fact-find."
}
Response examples (201)
{
"uuid": "eecf7bee-aa2c-4733-bef6-bb0f8853ab94",
"schema": {
"name": "Default fact-find",
"uuid": "317a3199-518a-413b-bef4-23fda279ce91",
"created_at": "2025-10-08T10:40:16+01:00",
"public_url": "https://api.plannrcrm.com/fact-find/1fbddc2f-42f3-41e7-b942-4c4218f95f18",
"updated_at": "2025-10-08T10:40:16+01:00",
"archived_at": "2025-10-07T10:40:16+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": "f034c73d-279d-4d72-ae01-7b3967d50798",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-10-08T10:40:16+01:00",
"first_name": "Gareth",
"updated_at": "2025-10-08T10:40:16+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"created_at": "2025-10-08T10:40:16+01:00",
"updated_at": "2025-10-08T10:40:16+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": "35e0de88-973d-4b8a-95a4-5027b67d6158",
"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": "95469c1a-bf4e-4c43-ac31-4d84557ca425"
},
"created_at": "2025-10-08T10:40:16+01:00",
"updated_at": "2025-10-08T10:40:16+01:00",
"folder_name": "folder 2",
"uploaded_at": "2025-10-08T10:40:16+01:00",
"documentable": "Object",
"download_url": "https://api.plannrcrm.com/file/4a039996-e83f-4989-bcfb-64ad3c5bde2d/download",
"last_modified": "2025-10-08T10:40:16+01:00",
"documentable_type": "account",
"original_created_at": "2025-10-08T10:40:16+01:00"
},
"completed_at": "2025-10-03T10:40:16+01:00",
"invitation_url": "https://api.plannrcrm.com/fact-find/dec8a1a4-5287-466c-8689-7c319a122f95/882266ee-e11f-4752-bc93-3a0f25e57b0d",
"invitation_text": "Please complete this fact-find!",
"fact_find_passes": {
"firm": {
"name": "Codepotato Ltd",
"uuid": "05bd66df-2701-4e39-b47d-ec0fc8f9bc26"
},
"uuid": "cc459776-1c19-46fa-ab17-5ece20e7a3fd",
"circle": {
"name": "The Codepotato Gang",
"uuid": "54429d2a-1e3e-42ae-9c16-570acd72f849"
},
"account": "App\\Http\\Resources\\MinimalAccountResource",
"progress": 50,
"created_at": "2025-10-08T10:40:16+01:00",
"expires_at": "2025-10-08T10:40:16+01:00",
"updated_at": "2025-10-08T10:40:16+01:00",
"is_complete": false,
"completed_sections": 2
}
}