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":"6926d906-1a09-4317-ac5d-56530b06a4fe","client_uuid":"d53562ee-80f3-43e9-a9aa-3e7d96ac805d","circle_uuid":"fb9665c5-41a7-47ec-88c2-536af80372e7","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": "6926d906-1a09-4317-ac5d-56530b06a4fe",
"client_uuid": "d53562ee-80f3-43e9-a9aa-3e7d96ac805d",
"circle_uuid": "fb9665c5-41a7-47ec-88c2-536af80372e7",
"send_invitation_email": true,
"invitation_text": "Please complete this fact-find."
}
Response examples (201)
{
"uuid": "b414e29e-e460-474d-9138-cca97cba60f6",
"schema": {
"name": "Default fact-find",
"uuid": "c3e1c0f0-e4ad-4bea-a43b-6c98cf683008",
"created_at": "2025-10-29T14:01:53+00:00",
"public_url": "https://api.plannrcrm.com/fact-find/f0510395-b354-4d97-bc49-f748a6fa4cb3",
"updated_at": "2025-10-29T14:01:53+00:00",
"archived_at": "2025-10-28T14:01:53+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",
"account": {
"name": "Gareth Thompson",
"role": "client",
"type": "client",
"uuid": "ac05728b-a484-4d0b-b34c-f3940ac62a86",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-10-29T14:01:53+00:00",
"first_name": "Gareth",
"updated_at": "2025-10-29T14:01:53+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
},
"created_at": "2025-10-29T14:01:53+00:00",
"updated_at": "2025-10-29T14:01:53+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": "d487d596-90c2-4163-8d70-3dc312dbc26e",
"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": "0b9c5fd2-07e1-4b03-a757-56c78d987c86"
},
"created_at": "2025-10-29T14:01:53+00:00",
"updated_at": "2025-10-29T14:01:53+00:00",
"folder_name": "folder 2",
"uploaded_at": "2025-10-29T14:01:53+00:00",
"documentable": "Object",
"download_url": "https://api.plannrcrm.com/file/c8ce8551-f62a-4bb3-914c-2278aaa4a35a/download",
"last_modified": "2025-10-29T14:01:53+00:00",
"documentable_type": "account",
"original_created_at": "2025-10-29T14:01:53+00:00"
},
"completed_at": "2025-10-24T14:01:53+01:00",
"invitation_url": "https://api.plannrcrm.com/fact-find/0d963e91-defd-4a8c-95a9-cd50da5d7b16/f86529c6-485f-43cd-8973-78d2a3333b5c",
"invitation_text": "Please complete this fact-find!",
"fact_find_passes": {
"firm": {
"name": "Codepotato Ltd",
"uuid": "f38db838-c651-4c62-a0f4-54be796e1b0a"
},
"uuid": "ac4b68ba-bc92-4106-8a9f-69694230f63f",
"circle": {
"name": "The Codepotato Gang",
"uuid": "484349f0-c202-478a-8dc5-bf926e0d9f74"
},
"account": "App\\Http\\Resources\\MinimalAccountResource",
"progress": 50,
"created_at": "2025-10-29T14:01:53+00:00",
"expires_at": "2025-10-29T14:01:53+00:00",
"updated_at": "2025-10-29T14:01:53+00:00",
"is_complete": false,
"completed_sections": 2
}
}