Create a fact-find request Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://apidocs.plannrcrm.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "PlannrCRM MCP server": {
    "url": "https://apidocs.plannrcrm.com/mcp"
  }
}
Close
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":"d60b8810-7ae3-4136-9d15-6fdea2244e44","client_uuid":"27ad3d9c-2512-44b0-b849-783179e55dfa","circle_uuid":"1e0bdc2a-a566-4120-b37c-1344120b97f1","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": "d60b8810-7ae3-4136-9d15-6fdea2244e44",
  "client_uuid": "27ad3d9c-2512-44b0-b849-783179e55dfa",
  "circle_uuid": "1e0bdc2a-a566-4120-b37c-1344120b97f1",
  "send_invitation_email": true,
  "invitation_text": "Please complete this fact find."
}
Response examples (201) 
{
  "uuid": "22831234-1e33-4e3c-8f95-29486f54d95d",
  "created_at": "2026-06-27T09:33:42+01:00",
  "updated_at": "2026-06-27T09:33:42+01:00",
  "status": "complete",
  "completed_at": "2026-06-22T09:33:42+01:00",
  "invitation_text": "Please complete this fact find!",
  "schema": {
    "uuid": "4e322a83-671f-4204-b545-b81ccf38002f",
    "created_at": "2026-06-27T09:33:42+01:00",
    "updated_at": "2026-06-27T09:33:42+01:00",
    "archived_at": "2026-06-26T09:33:42+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/4d0953af-3b79-4953-b909-df440d6be168"
  },
  "latest_file": {
    "uuid": "75e347ca-5a4b-419d-95de-4dc7a6ba0a1f",
    "created_at": "2026-06-27T09:33:42+01:00",
    "original_created_at": "2026-06-27T09:33:42+01:00",
    "updated_at": "2026-06-27T09:33:42+01:00",
    "uploaded_at": "2026-06-27T09:33:42+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-06-27T09:33:42+01:00",
    "progress": "100",
    "download_url": "https://api.plannrcrm.com/file/2c5656e8-7ce3-46e9-9065-734a6f336a00/download",
    "folder_name": "folder 2",
    "folder": "App\\Http\\Resources\\FolderResource",
    "documentable_type": "account",
    "documentable": "Object",
    "navigator": {
      "model_type": "account",
      "model_uuid": "7647b9a4-f6cd-4305-887f-ce62e93011e8"
    },
    "firm": "App\\Http\\Resources\\FirmResource",
    "account": "App\\Http\\Resources\\MinimalAccountResource",
    "tags": "App\\Http\\Resources\\TagResource"
  },
  "account": {
    "uuid": "b524e7a7-e036-4554-9b15-c6e7dba72fd0",
    "created_at": "2026-06-27T09:33:42+01:00",
    "updated_at": "2026-06-27T09:33:42+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/7d7a2457-c947-4a67-b2b9-8dc7467d2ef6/4cbbac7a-43c8-4319-b096-759def42c59d",
  "fact_find_passes": {
    "uuid": "431764b3-1aa3-4e65-8e04-140fc7d3f7dd",
    "created_at": "2026-06-27T09:33:42+01:00",
    "updated_at": "2026-06-27T09:33:42+01:00",
    "firm": {
      "uuid": "55167ba2-0ebb-4600-8681-3c8d35db11e5",
      "name": "Codepotato Ltd"
    },
    "account": "App\\Http\\Resources\\MinimalAccountResource",
    "circle": {
      "uuid": "a8e882b3-8c73-4316-8c0a-e4e49e3f4253",
      "name": "The Codepotato Gang"
    },
    "expires_at": "2026-06-27T09:33:42+01:00",
    "progress": 50,
    "is_complete": false,
    "completed_sections": 2
  }
}