Get all client cases

GET /api/v1/client/{client_uuid}/cases

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Path parameters

client_uuid string Required

Query parameters

include string

Comma separated list of relationships to include in the response. Valid relationships are [participants, participants_count, type, status, tags, plans, custom_fields, groups, assigned_to].
filter[uuid] string

Filter by a comma separated list of UUIDs.
filter[completed] boolean

Filter cases by which have been completed
filter[in_progress] boolean

Filter cases by which are still in progress
filter[type] string

Comma separated list of case type UUIDs. Example fc4e2fad-d4f1-5c56-a869-60edc441ae16,add547bc-6097-5339-aaba-cbea59e79ee1
filter[status] string

Comma separated string of statuses to filter by
filter[tags] string

Comma separated string of tags to filter by
filter[plan_uuid] string

Comma separated string of plan UUIDs to filter by.
filter[group_uuids] string

Comma separated string of group UUIDs to filter by.
filter[account_uuids] string

Comma separated string of account UUIDs to filter by.
filter[circle_uuids] string

Comma separated string of circle UUIDs to filter by.
filter[employee_account_uuids] string

Comma separated string of employee accounts UUIDs to filter by.
filter[completed_after] string

Filter cases which have a completed at date after.
filter[completed_before] string

Filter cases which have a completed at date before.
filter[review_at_after] string

Filter cases which have a review at date after.
filter[review_at_before] string

Filter cases which have a review at date before.
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, name, status_position, value, completed_at, review_at]. 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
  
  slug string
  
  status object
  
  Hide status attributes Show status attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  name string
  
  colour string
  
  position integer
  
  is_type_completed boolean
  
  type object
  
  Hide type attributes Show type attributes object
  
  uuid string
  
  name string
  
  created_at string
  
  updated_at string
  
  review_at string
  
  assigned_to_uuids array[string]
  
  group_uuids array[string]
  
  completed_at string
  
  value object
  
  Hide value attributes Show value 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
  
  status_position integer
  
  participants_count integer
  
  participants object
  
  Hide participants attributes Show participants attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  photo_url string
  
  firm string
  
  primary_phone_number string
  
  primary_email string
  
  current_time_entry string
  
  assigned_adviser string
  
  assigned_administrator string
  
  assigned_paraplanner string
  
  introduced_by string
  
  groups string
  
  tags string
  
  owners string
  
  first_contact_date string
  
  next_review_date string
  
  previous_review_date string
  
  anniversary_review_date string
  
  with_login boolean
  
  has_joint_account boolean
  
  can_be_deleted string
  
  joint_account_circle string
  
  circles string
  
  ownership_percentage integer
  
  inactive_at string
  
  custom_fields string
  
  external_references string
  
  task_board_uuid string
  
  plans object
  
  Hide plans attributes Show plans attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  opened_at string
  
  name string
  
  type string
  
  sub_type string
  
  abstract_type string
  
  policy_number string
  
  proposal_reference string
  
  status string
  
  inactive_at string
  
  inactive_reason string
  
  agency_in_your_name boolean
  
  agency_in_your_name_from string
  
  originally_sold_by_firm boolean
  
  under_advice boolean
  
  visible_on_client_portal boolean
  
  include_in_client_valuation boolean
  
  show_on_joint boolean
  
  shown_on_circles boolean
  
  review_date string
  
  on_panel boolean
  
  is_group_scheme boolean
  
  is_sub_group_scheme boolean
  
  is_group_scheme_member boolean
  
  advice_area string
  
  main_account string
  
  sub_accounts string
  
  provider string
  
  covers string
  
  claims string
  
  total_benefit_amount object
  
  Hide total_benefit_amount attributes Show total_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
  
  total_benefits object
  
  Hide total_benefits attributes Show total_benefits attributes object
  
  critical_illness object
  
  Hide critical_illness attributes Show critical_illness 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
  
  family_income_benefit object
  
  Hide family_income_benefit attributes Show family_income_benefit 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
  
  latest_valuations string
  
  value object
  
  Hide value attributes Show value 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
  
  valued_at string
  
  original_valued_at string
  
  client string
  
  accounts string
  
  seller string
  
  linked_owners string
  
  linked_plans string
  
  statistics object
  
  Hide statistics attribute Show statistics attribute object
  
  recent_growth integer
  
  cases string
  
  tags string
  
  is_wrap_product boolean
  
  is_wrap_child boolean
  
  wrap string
  
  wrap_children string
  
  can_be_deleted string
  
  contract_enquiry_account string
  
  custom_fields string
  
  external_references string
  
  custom_fields array[object]
  
  Hide custom_fields attributes Show custom_fields attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  name string
  
  reference string
  
  is_required boolean
  
  value string
  
  selection_options array[string]
  
  help_text string

GET /api/v1/client/{client_uuid}/cases

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

Response examples (200)

{
  "data": [
    {
      "name": "finance",
      "slug": "finance",
      "type": {
        "name": "Mortgage Plan",
        "uuid": "223ea2af-8d1b-41ad-871f-88338047d728",
        "created_at": "2025-08-27T17:31:25+01:00",
        "updated_at": "2025-08-27T17:31:25+01:00"
      },
      "uuid": "73580740-4fb8-4f59-9eb1-44d04aad63ca",
      "plans": {
        "name": "Johns ISA",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "cash_account",
        "uuid": "b24bc63a-669d-4df2-ab7b-4af3a252529e",
        "wrap": "App\\Http\\Resources\\Plans\\PlanResource",
        "cases": "App\\Http\\Resources\\CasesResource",
        "value": {
          "amount": {
            "example": "4000",
            "description": "Money amount at their lowest denominator (for example: pennies)"
          },
          "currency": {
            "example": "GBP",
            "description": "Currency of the money"
          },
          "formatted": {
            "example": "£40.00",
            "description": "Money amount formatted with currency"
          }
        },
        "claims": "App\\Http\\Resources\\Plans\\ClaimResource",
        "client": "App\\Http\\Resources\\AccountResource",
        "covers": "App\\Http\\Resources\\Plans\\CoverResource",
        "seller": "App\\Http\\Resources\\AccountResource",
        "status": "inactive",
        "accounts": "App\\Http\\Resources\\AccountResource",
        "on_panel": true,
        "provider": "App\\Http\\Resources\\Plans\\ProviderResource",
        "sub_type": "lifetime isa",
        "opened_at": "2025-08-27T17:31:25+01:00",
        "valued_at": "2025-08-27T17:31:25+01:00",
        "created_at": "2025-08-27T17:31:25+01:00",
        "statistics": {
          "recent_growth": 100
        },
        "updated_at": "2025-08-27T17:31:25+01:00",
        "advice_area": "non_investment_insurance",
        "inactive_at": "2025-08-27T17:31:25+01:00",
        "review_date": "2024-08-27",
        "linked_plans": "App\\Http\\Resources\\Plans\\PlanResource",
        "main_account": "App\\Http\\Resources\\Plans\\SubAccountResource",
        "sub_accounts": "App\\Http\\Resources\\Plans\\SubAccountResource",
        "under_advice": true,
        "abstract_type": "asset",
        "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
        "is_wrap_child": false,
        "linked_owners": "App\\Http\\Resources\\AccountResource",
        "policy_number": "AVIVA-123",
        "show_on_joint": true,
        "wrap_children": "App\\Http\\Resources\\Plans\\PlanResource",
        "can_be_deleted": "false",
        "total_benefits": {
          "critical_illness": {
            "amount": {
              "example": "15000000",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "currency": {
              "example": "GBP",
              "description": "Currency of the money"
            },
            "formatted": {
              "example": "£150,000.00",
              "description": "Money amount formatted with currency"
            }
          },
          "family_income_benefit": {
            "amount": {
              "example": "10000000",
              "description": "Money amount at their lowest denominator (for example: pennies)"
            },
            "currency": {
              "example": "GBP",
              "description": "Currency of the money"
            },
            "formatted": {
              "example": "£100,000.00",
              "description": "Money amount formatted with currency"
            }
          }
        },
        "inactive_reason": "claimed",
        "is_group_scheme": false,
        "is_wrap_product": false,
        "shown_on_circles": true,
        "latest_valuations": "App\\Http\\Resources\\Plans\\ValuationResource",
        "original_valued_at": "2025-08-26T17:31:25+01:00",
        "proposal_reference": "AB123456",
        "agency_in_your_name": true,
        "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
        "is_sub_group_scheme": false,
        "total_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"
          }
        },
        "is_group_scheme_member": false,
        "originally_sold_by_firm": true,
        "agency_in_your_name_from": "2024-08-27",
        "contract_enquiry_account": "App\\Http\\Resources\\AccountResource",
        "visible_on_client_portal": true,
        "include_in_client_valuation": true
      },
      "value": {
        "amount": {
          "example": "4000",
          "description": "Money amount at their lowest denominator (for example: pennies)"
        },
        "currency": {
          "example": "GBP",
          "description": "Currency of the money"
        },
        "formatted": {
          "example": "£40.00",
          "description": "Money amount formatted with currency"
        }
      },
      "status": {
        "name": "To Be Reviewed",
        "uuid": "ecdc4ee1-c98d-47e4-8180-cd5abf8e5b5e",
        "colour": "#23852B",
        "position": 5,
        "created_at": "2025-08-27T17:31:25+01:00",
        "updated_at": "2025-08-27T17:31:25+01:00",
        "is_type_completed": false
      },
      "review_at": "2025-08-27T17:31:25+01:00",
      "created_at": "2025-08-27T17:31:25+01:00",
      "updated_at": "2025-08-27T17:31:25+01:00",
      "group_uuids": [
        "900b14bf-ef52-4590-9dd0-df5e8b0e602e"
      ],
      "completed_at": "2025-08-27T17:31:25+01:00",
      "participants": {
        "firm": "App\\Http\\Resources\\FirmResource",
        "name": "Gareth Thompson",
        "role": "client",
        "tags": "App\\Http\\Resources\\TagResource",
        "type": "client",
        "uuid": "ade2f69b-c5ff-45dd-9c0c-b96326c3711e",
        "email": "gareth@codepotato.co.uk",
        "groups": "App\\Http\\Resources\\GroupResource",
        "owners": "App\\Http\\Resources\\AccountResource",
        "circles": "App\\Http\\Resources\\CircleResource",
        "last_name": "Thompson",
        "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
        "created_at": "2025-08-27T17:31:25+01:00",
        "first_name": "Gareth",
        "updated_at": "2025-08-27T17:31:25+01:00",
        "with_login": true,
        "inactive_at": "2025-08-27",
        "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-08-27T17:31:25+01:00",
        "has_joint_account": true,
        "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
        "first_contact_date": "2025-08-27T17:31:25+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-08-27T17:31:25+01:00",
        "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
        "assigned_administrator": "App\\Http\\Resources\\AccountResource",
        "anniversary_review_date": "2025-08-27T17:31:25+01:00"
      },
      "custom_fields": [
        {
          "name": "Favourite Drink",
          "type": "string",
          "uuid": "1c671eb1-c7aa-4ef1-a014-dcda812563fd",
          "value": "Coffee",
          "help_text": "This is the client's favourite drink.",
          "reference": "favourite_drink",
          "created_at": "2025-08-27T17:31:25+01:00",
          "updated_at": "2025-08-27T17:31:25+01:00",
          "is_required": false,
          "selection_options": [
            "Coffee",
            "Tea",
            "Water"
          ]
        }
      ],
      "status_position": 4,
      "task_board_uuid": "7c61893c-f827-479a-9f7d-79d717ee2954",
      "assigned_to_uuids": [
        "9d91ebe2-2c46-42af-9bbe-cbcb83aa137d"
      ],
      "participants_count": 4
    }
  ]
}