Get a beneficiary of a plan

GET /api/v1/plans/{plan_uuid}/beneficiary/{uuid}

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Path parameters

plan_uuid string Required
uuid string Required

Responses

200 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- name string
  
  Beneficiary name.
- percentage integer
  
  Beneficiary percentage.
- cover object
  
  Cover this beneficiary is for.
  
  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/{uuid}

curl \
 --request GET 'https://api.plannrcrm.com/api/v1/plans/6ff8f7f6-1eb3-3525-be4a-3932c805afed/beneficiary/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"

Response examples (200)

{
  "name": "Beneficiary name",
  "uuid": "14e59947-e524-4477-898e-a2740cab09c1",
  "cover": {
    "uuid": "681ac4e6-9fb5-45d7-a497-e0ed50bcea81",
    "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-07-17T16:23:23+01:00",
    "indexation": 1.4,
    "updated_at": "2025-07-17T16:23:23+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-07-17T16:23:23+01:00",
  "percentage": 50,
  "updated_at": "2025-07-17T16:23:23+01:00"
}