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 object
        Hide client attributes Show client attributes object

        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • type

          Account type

        • role

          Account role

        • first_name

          First name

        • last_name

          Last name

        • name

          Name

        • email

          (Deprecated - Please use primary_email instead). The email of the account.

        • photo_url

          URL for initial avatar image

        • first_contact_date

          First contact date

        • next_review_date

          Next review date

        • previous_review_date

          Previous review date

        • anniversary_review_date

          Anniversary review date

        • terms_of_business_at

          Date the Terms of Business were agreed and signed

        • client_agreement_at

          Date the client agreement was agreed and signed

        • with_login

          Denotes whether the account has a login to Plannr

        • has_joint_account

          Denotes whether this account belongs to a joint account too

        • can_be_deleted

          Denotes if the account can be deleted

        • ownership_percentage

          Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)

        • inactive_at

          Inactive from date

        • last_interaction_at

          Last interaction date

        • referral_code

          Unique referral code for the employee account (employees only)

        • permissions

          Permission map where keys are permission names and values are target arrays