Create a fact-find request

POST /api/v1/fact-find/request

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

application/json

Body Required

fact_find_schema_uuid string Required

The UUID of the fact-find schema that you would like the client to use.
client_uuid string Required

The UUID of the client account to send the fact-find request. This must only be individual clients. Cannot be used with circle_uuid.
circle_uuid string Required

The UUID of the circle to send the fact-find request to. Cannot be used with client_uuid.
send_invitation_email boolean

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.
invitation_text string

The text that will appear in the invitation email sent to the client (if enabled)

Responses

201 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.
  
  Hide schema attributes Show schema attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  archived_at string
  
  is_archived boolean
  
  name string
  
  introduction_html string
  
  sections_count integer
  
  public_url string
- latest_file object
  
  The latest file that has been generated for the fact-find request.
  
  Hide latest_file attributes Show latest_file attributes object
  
  uuid string
  
  created_at string
  
  original_created_at string
  
  updated_at string
  
  uploaded_at string
  
  status string
  
  filename string
  
  name string
  
  extension string
  
  type string
  
  size string
  
  path string
  
  last_modified string
  
  progress string
  
  download_url string
  
  folder_name string
  
  folder string
  
  documentable_type string
  
  documentable string
  
  navigator object
  
  Hide navigator attributes Show navigator attributes object
  
  model_type string
  
  model_uuid string
  
  firm string
  
  account string
  
  tags string
- account object
  
  The account that the fact-find request was sent to. Only visible when listing fact-find requests for a circle.
  
  Hide account attributes Show account attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  photo_url string
  
  external_references string
- invitation_url string
  
  The invitation URL sent to the client.
- fact_find_passes object
  
  The fact find passes added to the fact-find request.
  
  Hide fact_find_passes attributes Show fact_find_passes attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  firm object
  
  Hide firm attributes Show firm attributes object
  
  uuid string
  
  name string
  
  account string
  
  circle object
  
  Hide circle attributes Show circle attributes object
  
  uuid string
  
  name string
  
  expires_at string
  
  progress integer
  
  is_complete boolean
  
  completed_sections integer

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":"7c718d11-f85e-42f9-abc1-c3c0846671ba","client_uuid":"826ffd31-1070-4b02-bf80-97dd8d35a7f1","circle_uuid":"5cba3088-3d42-46df-a0d7-cb31127ca8ba","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": "7c718d11-f85e-42f9-abc1-c3c0846671ba",
  "client_uuid": "826ffd31-1070-4b02-bf80-97dd8d35a7f1",
  "circle_uuid": "5cba3088-3d42-46df-a0d7-cb31127ca8ba",
  "send_invitation_email": true,
  "invitation_text": "Please complete this fact-find."
}

Response examples (201)

{
  "uuid": "fd4b98e7-2d28-4990-b7a1-61067235edd2",
  "schema": {
    "name": "Default fact-find",
    "uuid": "e466633d-a740-4d5f-910b-0287caea838e",
    "created_at": "2025-06-26T11:37:09+01:00",
    "public_url": "https://api.plannrcrm.com/fact-find/42438805-70ba-4bee-8079-0cf00f1828ad",
    "updated_at": "2025-06-26T11:37:09+01:00",
    "archived_at": "2025-06-25T11:37:09+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": "87d8cec5-309a-426f-a171-45ea3d607aac",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2025-06-26T11:37:09+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-06-26T11:37:09+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "created_at": "2025-06-26T11:37:09+01:00",
  "updated_at": "2025-06-26T11:37:09+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": "d891dfcc-b68d-4654-b885-fe4267a2ba42",
    "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": "5aea2856-c94f-4391-ab9b-282bd41728dd"
    },
    "created_at": "2025-06-26T11:37:09+01:00",
    "updated_at": "2025-06-26T11:37:09+01:00",
    "folder_name": "folder 2",
    "uploaded_at": "2025-06-26T11:37:09+01:00",
    "documentable": "Object",
    "download_url": "https://api.plannrcrm.com/file/14a2659b-9d5a-43b8-b039-81c0a106f4e5/download",
    "last_modified": "2025-06-26T11:37:09+01:00",
    "documentable_type": "account",
    "original_created_at": "2025-06-26T11:37:09+01:00"
  },
  "completed_at": "2025-06-21T11:37:09+01:00",
  "invitation_url": "https://api.plannrcrm.com/fact-find/80250b2d-1e90-4802-904e-00a5837bb120/82f9e4e9-d343-41d3-bfbc-b1072de39a40",
  "invitation_text": "Please complete this fact-find!",
  "fact_find_passes": {
    "firm": {
      "name": "Codepotato Ltd",
      "uuid": "049fe016-1ba3-449c-8195-7c4e51263a09"
    },
    "uuid": "01dbc097-708b-4f2f-b678-529a1532d970",
    "circle": {
      "name": "The Codepotato Gang",
      "uuid": "fc8b61a6-a4ba-4522-8e2b-d46868d8cd84"
    },
    "account": "App\\Http\\Resources\\MinimalAccountResource",
    "progress": 50,
    "created_at": "2025-06-26T11:37:09+01:00",
    "expires_at": "2025-06-26T11:37:09+01:00",
    "updated_at": "2025-06-26T11:37:09+01:00",
    "is_complete": false,
    "completed_sections": 2
  }
}