POST /api/v1/fact-find/request
Personal access token & O auth2

Headers

  • X-PLANNR-ACCOUNT-UUID string
application/json

Body

  • fact_find_schema_uuid string(uuid) Required

    The UUID of the fact find schema that you would like the client to use.

  • client_uuid string(uuid) 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(uuid) 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,approved,rejected

    • 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":"b1cfbd17-3249-40c6-8509-cbe9da82b9dd","client_uuid":"adc4eff6-192b-4675-bc2b-50b8a72301fd","circle_uuid":"38a66a39-6a7e-4146-aebd-fe816613204e","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": "b1cfbd17-3249-40c6-8509-cbe9da82b9dd",
  "client_uuid": "adc4eff6-192b-4675-bc2b-50b8a72301fd",
  "circle_uuid": "38a66a39-6a7e-4146-aebd-fe816613204e",
  "send_invitation_email": true,
  "invitation_text": "Please complete this fact find."
}
Response examples (201) 
{
  "uuid": "75d77de7-ed56-41b5-b68d-324306e92bed",
  "created_at": "2026-04-29T16:54:32+01:00",
  "updated_at": "2026-04-29T16:54:32+01:00",
  "status": "complete",
  "completed_at": "2026-04-24T16:54:32+01:00",
  "invitation_text": "Please complete this fact find!",
  "schema": {
    "uuid": "81b0d8ec-7a04-4328-adf7-065ed4cfb9a9",
    "created_at": "2026-04-29T16:54:32+01:00",
    "updated_at": "2026-04-29T16:54:32+01:00",
    "archived_at": "2026-04-28T16:54:32+01:00",
    "is_archived": false,
    "name": "Default fact find",
    "introduction_html": "Welcome to our fact find! <b>You can use some HTML too.</b>",
    "sections_count": 5,
    "public_url": "https://api.plannrcrm.com/fact-find/328284ab-7009-4b02-a180-177faef80323"
  },
  "latest_file": {
    "uuid": "3fecb278-f830-4245-85f3-4aeff66ef1b3",
    "created_at": "2026-04-29T16:54:32+01:00",
    "original_created_at": "2026-04-29T16:54:32+01:00",
    "updated_at": "2026-04-29T16:54:32+01:00",
    "uploaded_at": "2026-04-29T16:54:32+01:00",
    "status": "uploaded",
    "filename": "Welcome to Plannr.pdf",
    "name": "Welcome to Plannr",
    "extension": "pdf",
    "type": "type",
    "size": "21691783",
    "path": "Gareth Thompson/Subfolder/Welcome to Plannr.pdf",
    "last_modified": "2026-04-29T16:54:32+01:00",
    "progress": "100",
    "download_url": "https://api.plannrcrm.com/file/6fc5fb76-c99a-4292-8b0c-7054ab711f9c/download",
    "folder_name": "folder 2",
    "folder": "App\\Http\\Resources\\FolderResource",
    "documentable_type": "account",
    "documentable": "Object",
    "navigator": {
      "model_type": "account",
      "model_uuid": "4d4e30af-2bcf-4f07-af04-5c5b7ae81279"
    },
    "firm": "App\\Http\\Resources\\FirmResource",
    "account": "App\\Http\\Resources\\MinimalAccountResource",
    "tags": "App\\Http\\Resources\\TagResource"
  },
  "account": {
    "uuid": "8f456d07-7685-4404-89e8-3ed3cfb19ba8",
    "created_at": "2026-04-29T16:54:32+01:00",
    "updated_at": "2026-04-29T16:54:32+01:00",
    "type": "client",
    "role": "client",
    "first_name": "Gareth",
    "last_name": "Thompson",
    "name": "Gareth Thompson",
    "email": "gareth@codepotato.co.uk",
    "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  },
  "invitation_url": "https://api.plannrcrm.com/fact-find/40cfe388-85df-4d03-ab8d-7b69242672e2/be716ba0-65b8-45d4-996e-2795323fc597",
  "fact_find_passes": {
    "uuid": "57e057ab-1f4f-4d9f-841f-a07037224a0a",
    "created_at": "2026-04-29T16:54:32+01:00",
    "updated_at": "2026-04-29T16:54:32+01:00",
    "firm": {
      "uuid": "6ad013bd-5565-476e-a43f-e36f789d2cea",
      "name": "Codepotato Ltd"
    },
    "account": "App\\Http\\Resources\\MinimalAccountResource",
    "circle": {
      "uuid": "066625c8-32f4-49e2-ab4c-8927770216e3",
      "name": "The Codepotato Gang"
    },
    "expires_at": "2026-04-29T16:54:32+01:00",
    "progress": 50,
    "is_complete": false,
    "completed_sections": 2
  }
}