Get all beneficiaries of a plan

GET /api/v1/plans/{plan_uuid}/beneficiary
Personal access token & O auth2

Query parameters

  • filter[created_after] string

    Date to filter when the beneficiary was created after. Example 2022-04-05

  • filter[created_before] string

    Date to filter when the beneficiary was created before. Example 2022-05-31

  • filter[updated_after] string

    Date to filter when the beneficiary was created after. Example 2022-04-05

  • filter[updated_before] string

    Date to filter when the beneficiary was created before. Example 2022-05-31

  • filter[name] string

    Name to filter who the beneficiary is. Example John Smith

  • filter[percentage] number

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

  • 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
GET /api/v1/plans/{plan_uuid}/beneficiary 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/plans/plan_uuid/beneficiary' \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "name": "Beneficiary name",
      "uuid": "65261a18-5d65-447c-aea0-6277bc1beaea",
      "cover": {
        "uuid": "e4d65825-f419-4b17-9101-965d44cadb00",
        "client": "App\\Http\\Resources\\AccountResource",
        "excess": {
          "amount": {
            "example": "10000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          },
          "formatted": {
            "example": "£100.00",
            "description": "Money amount formatted with currency"
          }
        },
        "cover_type": "critical_illness",
        "created_at": "2025-04-02T13:27:57+01:00",
        "indexation": 1.4,
        "updated_at": "2025-04-02T13:27:57+01:00",
        "benefit_amount": {
          "amount": {
            "example": "25000000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          },
          "formatted": {
            "example": "£250,000.00",
            "description": "Money amount formatted with currency"
          }
        },
        "benefit_status": "active",
        "benefit_frequency": "monthly"
      },
      "created_at": "2025-04-02T13:27:57+01:00",
      "percentage": 50,
      "updated_at": "2025-04-02T13:27:57+01:00"
    }
  ]
}