Launch a fact-find session as an adviser on behalf of a client. 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
GET /api/v2/fact-find-session/{factFindSession_uuid}/account/{account_uuid}

This endpoint allows an adviser to launch a fact-find session for one of their clients. On success, a 6-hour authenticated session is established for the fact-find and the session data is returned so the frontend can render the fact-find page. The session data will include a launched_by_account_uuid to identify the adviser.

Path parameters

  • factFindSession_uuid string Required
  • account_uuid string Required
  • factFindSession string Required

    The UUID of the fact-find session.

  • account string Required

    The UUID of the client account to launch on behalf of.

GET /api/v2/fact-find-session/{factFindSession_uuid}/account/{account_uuid}
curl \
 --request GET 'https://api.plannrcrm.com/api/v2/fact-find-session/6ff8f7f6-1eb3-3525-be4a-3932c805afed/account/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
The fact-find session was launched successfully and is returned in the response body.
Response examples (403)
The adviser does not have access to this client or the account is not on the session.
Response examples (404)
The fact-find session or account UUID does not exist.