Get all covers of a plan

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

Query parameters

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • filter[cover_type] string

    Comma separate string of cover types to filter by.

  • filter[benefit_status] string

    Comma separate string of benefit statuses to filter by.

  • sort string

    Field to sort by. Valid fields are [created_at, updated_at, type, benefit_status, benefit_amount]. Negative sign to denote DESC. Defaults to '-created_at'.

  • per_page integer

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

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
GET /api/v1/plans/{plan_uuid}/cover 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/plans/plan_uuid/cover' \
 --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": [
    {
      "uuid": "1a576dc5-eeb1-4bd5-857f-0f834f2b26f0",
      "client": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "a4f21fe8-1e33-4464-b047-3b65ecc370a8",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "last_name": "Thompson",
        "created_at": "2025-04-02T13:27:57+01:00",
        "first_name": "Gareth",
        "updated_at": "2025-04-02T13:27:57+01:00",
        "with_login": true,
        "inactive_at": "2025-04-02",
        "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
        "introduced_by": "App\\Http\\Resources\\AccountResource",
        "primary_email": "App\\Http\\Resources\\ContactDetailResource",
        "can_be_deleted": "false",
        "assigned_adviser": "App\\Http\\Resources\\AccountResource",
        "next_review_date": "2025-04-02T13:27:57+01:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2025-04-02T13:27:57+01:00",
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
        "joint_account_circle": "App\\Http\\Resources\\CircleResource",
        "ownership_percentage": 100,
        "previous_review_date": "2025-04-02T13:27:57+01:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2025-04-02T13:27:57+01:00"
      },
      "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"
    }
  ]
}