Portal Engagement Summary 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/v1/portal-engagement/summary
Personal access token & O auth2

Get an aggregate summary of client portal engagement across the firm. Includes total clients with/without portal access, login counts for 30/90/365 day rolling windows, and never-logged-in counts.

Optionally filterable by assigned adviser UUID.

Query parameters

  • filter[assigned_adviser] string

    UUID of an adviser to filter by.

Responses

  • 401 application/json
    Hide response attribute Show response attribute object
    • message string Required

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

    Validation error

    Hide response attributes Show response attributes object
    • message string Required

      A human-readable description of the error.

    • errors object

      Validation messages keyed by the field that failed.

      Hide errors attribute Show errors attribute object
      • * array[string] Additional properties
GET /api/v1/portal-engagement/summary 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/portal-engagement/summary' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (401) 
{
  "message": "Unauthenticated."
}
Response examples (422) 
{
  "message": "The given data was invalid.",
  "errors": {
    "field": [
      "The field is invalid."
    ]
  }
}