Create a fact-find request

POST /api/v1/fact-find/request

Personal access token & O auth2

Headers

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.
- latest_file object
  
  The latest file that has been generated for the fact-find request.
- account object
  
  The account that the fact-find request was sent to. Only visible when listing fact-find requests for a circle.
- invitation_url string
  
  The invitation URL sent to the client.
- fact_find_passes object
  
  The fact find passes added to the fact-find request.

POST /api/v1/fact-find/request

curl \
 --request POST 'https://api.plannrcrm.com/api/v1/fact-find/request' \
 --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}" \
 --data '{"fact_find_schema_uuid":"07db2bdd-df7d-40d5-8229-1c60649c89e9","client_uuid":"2f714129-49c3-41a8-9dfc-80c0b8dead80","circle_uuid":"9fe082f2-ee95-44c6-9ef1-8eac836d376c","send_invitation_email":true,"invitation_text":"Please complete this fact-find."}'

Request examples

# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "fact_find_schema_uuid": "07db2bdd-df7d-40d5-8229-1c60649c89e9",
  "client_uuid": "2f714129-49c3-41a8-9dfc-80c0b8dead80",
  "circle_uuid": "9fe082f2-ee95-44c6-9ef1-8eac836d376c",
  "send_invitation_email": true,
  "invitation_text": "Please complete this fact-find."
}

Response examples (201)

{
  "uuid": "f40127a7-1906-4d0d-8331-777ff6802f20",
  "schema": {
    "name": "Default fact-find",
    "uuid": "5afcbb55-be4b-4c8f-81ce-e281cd036671",
    "created_at": "2025-06-05T11:39:42+01:00",
    "public_url": "https://plannr.valet/fact-find/1cf38d61-ca84-4e79-9d6c-5918d510d954",
    "updated_at": "2025-06-05T11:39:42+01:00",
    "archived_at": "2025-06-04T11:39:42+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": "3af6bd08-5440-4d75-92e6-bae73d22af57",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2025-06-05T11:39:42+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-06-05T11:39:42+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "created_at": "2025-06-05T11:39:42+01:00",
  "updated_at": "2025-06-05T11:39:42+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": "026bf437-47bc-45d0-8959-2aaadf819f9f",
    "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": "e9cb5088-908a-41ea-b647-b271fe482895"
    },
    "created_at": "2025-06-05T11:39:42+01:00",
    "updated_at": "2025-06-05T11:39:42+01:00",
    "folder_name": "folder 2",
    "uploaded_at": "2025-06-05T11:39:42+01:00",
    "documentable": "Object",
    "download_url": "https://plannr.valet/file/744555cb-ef9f-4fb6-8ee6-291e8456549e/download",
    "last_modified": "2025-06-05T11:39:42+01:00",
    "documentable_type": "account",
    "original_created_at": "2025-06-05T11:39:42+01:00"
  },
  "completed_at": "2025-05-31T11:39:42+01:00",
  "invitation_url": "https://plannr.valet/fact-find/b5ebf965-90bc-49b8-aca7-f3ffddf13aa5/3ed2f99e-17e3-4a52-809e-bafa82949966",
  "invitation_text": "Please complete this fact-find!",
  "fact_find_passes": {
    "firm": {
      "name": "Codepotato Ltd",
      "uuid": "53300bf4-02b6-4160-896e-ef262cf11a46"
    },
    "uuid": "89739488-4688-4481-ae6c-f5bcb9d13436",
    "circle": {
      "name": "The Codepotato Gang",
      "uuid": "7770c134-dfbf-4df0-bb82-4bb5da0e2f80"
    },
    "account": "App\\Http\\Resources\\MinimalAccountResource",
    "progress": 50,
    "created_at": "2025-06-05T11:39:42+01:00",
    "expires_at": "2025-06-05T11:39:42+01:00",
    "updated_at": "2025-06-05T11:39:42+01:00",
    "is_complete": false,
    "completed_sections": 2
  }
}