Get all beneficiaries of a plan

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 attributes Show data attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  percentage integer
  
  cover object
  
  Hide cover attributes Show cover attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  cover_type string
  
  benefit_amount object
  
  Hide benefit_amount attributes Show benefit_amount attributes object
  
  amount object
  
  Hide amount attributes Show amount attributes object
  
  example string
  
  description string
  
  formatted object
  
  Hide formatted attributes Show formatted attributes object
  
  example string
  
  description string
  
  currency object
  
  Hide currency attributes Show currency attributes object
  
  example string
  
  description string
  
  benefit_frequency string
  
  benefit_status string
  
  excess object
  
  Hide excess attributes Show excess attributes object
  
  amount object
  
  Hide amount attributes Show amount attributes object
  
  example string
  
  description string
  
  formatted object
  
  Hide formatted attributes Show formatted attributes object
  
  example string
  
  description string
  
  currency object
  
  Hide currency attributes Show currency attributes object
  
  example string
  
  description string
  
  indexation number
  
  client 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": [
    {
      "name": "Beneficiary name",
      "uuid": "77472fcc-382c-4759-8e65-f1453041e13c",
      "cover": {
        "uuid": "161cf4ff-435a-47bc-86d8-8a7cf1eb7cfd",
        "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-06-26T11:37:07+01:00",
        "indexation": 1.4,
        "updated_at": "2025-06-26T11:37:07+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-06-26T11:37:07+01:00",
      "percentage": 50,
      "updated_at": "2025-06-26T11:37:07+01:00"
    }
  ]
}