Launch a fact-find session as the 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}/launch
Personal access token & O auth2

This endpoint allows a client — or an adviser impersonating that client — to launch the client's fact-find session from the portal. 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.

When the request is authenticated via the mobile app, no session cookie is set. Instead, a X-Fact-Find-Session-Token header is returned containing a bearer token that must be included on all subsequent fact-find requests in place of the session cookie.

Path parameters

  • factFindSession_uuid string Required

    The UUID of the fact-find session.

Responses

  • 200
  • 401 application/json

    Unauthenticated

    Hide response attribute Show response attribute object
    • message string Required

      A human-readable description of the error.
  • 403 application/json

    Forbidden

    Hide response attribute Show response attribute object
    • message string Required

      A human-readable description of the error.
  • 404 application/json

    Not found

    Hide response attribute Show response attribute object
    • message string Required

      A human-readable description of the error.
GET /api/v2/fact-find/session/{factFindSession_uuid}/launch 
curl \
 --request GET 'https://api.plannrcrm.com/api/v2/fact-find/session/c33eea50-795b-4bb0-ac3e-925ab620147a/launch' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
The fact-find session was launched successfully and is returned in the response body.
Response examples (401) 
{
  "message": "No authenticated login was found on the request."
}
Response examples (403) 
{
  "message": "The client does not have access to this fact-find session."
}
Response examples (404) 
{
  "message": "The fact-find session UUID does not exist."
}