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":"ebba34f2-1651-4a26-8d55-0c93c7fc39fb","client_uuid":"f671f4e7-2120-4b38-a02d-c7d16aa59002","circle_uuid":"30d8a41b-aaf6-4694-8b63-4021a975f4be","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": "ebba34f2-1651-4a26-8d55-0c93c7fc39fb",
  "client_uuid": "f671f4e7-2120-4b38-a02d-c7d16aa59002",
  "circle_uuid": "30d8a41b-aaf6-4694-8b63-4021a975f4be",
  "send_invitation_email": true,
  "invitation_text": "Please complete this fact-find."
}

Response examples (201)

{
  "uuid": "d2f50fc3-511f-4a8e-9936-cd2fdb37c4a4",
  "schema": {
    "name": "Default fact-find",
    "uuid": "a5a9786d-ace9-4d3a-9dcc-c04a4fc0f4be",
    "created_at": "2025-05-14T18:27:15+01:00",
    "public_url": "https://plannr.valet/fact-find/771cd347-51bd-4546-bbce-8889f862f326",
    "updated_at": "2025-05-14T18:27:15+01:00",
    "archived_at": "2025-05-13T18:27:15+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": "132e6235-6292-4258-af81-e46275a4e61c",
    "email": "gareth@codepotato.co.uk",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "created_at": "2025-05-14T18:27:15+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-05-14T18:27:15+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "created_at": "2025-05-14T18:27:15+01:00",
  "updated_at": "2025-05-14T18:27:15+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": "f94869ee-1ebc-4ca6-a4c5-fbd2e7ec6bd9",
    "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": "0d008af2-b148-4396-9219-3faff2e94eb4"
    },
    "created_at": "2025-05-14T18:27:15+01:00",
    "updated_at": "2025-05-14T18:27:15+01:00",
    "folder_name": "folder 2",
    "uploaded_at": "2025-05-14T18:27:15+01:00",
    "documentable": "Object",
    "download_url": "https://plannr.valet/file/5225e490-71dd-491a-b8ec-3d86e14deefe/download",
    "last_modified": "2025-05-14T18:27:15+01:00",
    "documentable_type": "account",
    "original_created_at": "2025-05-14T18:27:15+01:00"
  },
  "completed_at": "2025-05-09T18:27:15+01:00",
  "invitation_url": "https://plannr.valet/fact-find/17d6bd6a-6253-4543-950b-b56be01fd1ba/595cc803-3aa4-4aa4-94e5-743aa8436ee2",
  "invitation_text": "Please complete this fact-find!",
  "fact_find_passes": {
    "firm": {
      "name": "Codepotato Ltd",
      "uuid": "44ad2654-1c46-4aae-91fd-b8dd71c16105"
    },
    "uuid": "6e8c8342-1625-4227-88ce-6a297003638c",
    "circle": {
      "name": "The Codepotato Gang",
      "uuid": "20100c4d-8e38-46eb-9690-758ad46c9458"
    },
    "account": "App\\Http\\Resources\\MinimalAccountResource",
    "progress": 50,
    "created_at": "2025-05-14T18:27:15+01:00",
    "expires_at": "2025-05-14T18:27:15+01:00",
    "updated_at": "2025-05-14T18:27:15+01:00",
    "is_complete": false,
    "completed_sections": 2
  }
}