Get all beneficiaries of a plan 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/plans/{plan_uuid}/beneficiary
Personal access token & O auth2

Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • plan_uuid string Required

Query parameters

  • filter[created_after] string

    Date to filter when the beneficiary was created after.

  • filter[created_before] string

    Date to filter when the beneficiary was created before.

  • filter[updated_after] string

    Date to filter when the beneficiary was created after.

  • filter[updated_before] string

    Date to filter when the beneficiary was created before.

  • filter[name] string

    Name to filter who the beneficiary is.

  • filter[percentage] number

    Percentage to filter the nominee percentage where 1 is equal to 100%.

  • per_page integer

    Number of results to return with pagination (Default 15. Max 500).

  • sort string

    Field to sort by. Valid fields are [created_at, updated_at, name, percentage]. Negative sign to denote DESC. Defaults to 'name'.

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • data array[object]
      Hide data attribute Show data attribute object
      • message string
GET /api/v1/plans/{plan_uuid}/beneficiary 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/plans/6ff8f7f6-1eb3-3525-be4a-3932c805afed/beneficiary' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "message": "Plan is being deleted."
    }
  ]
}