Get a case

GET /api/v1/cases/{uuid}
Personal access token & O auth2

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

      Name of the case

    • slug string

      Slug of the case

    • status object

      Case status

    • type object

      Case type

    • review_at string

      Timestamp of when the case should be reviewed

    • assigned_to_uuids array[string]

      UUIDs of accounts that will be assigned to the case when it is created.

    • group_uuids array[string]

      UUIDs of groups that will be assigned when the case is created.

    • completed_at string

      Timestamp of when the case was completed

    • value object

      Expected value of this case

    • status_position integer

      The case status's position on the status list. Starting from 1. Only used if you are formatting cases in a kanban layout.

    • participants_count integer

      The number of participants on the case

    • participants object

      Participants on this case (if included)

    • task_board_uuid string

      UUID of the task board

    • plans object

      Plans in this case (if included)

    • custom_fields array[object]

      Any custom fields on the model.
GET /api/v1/cases/{uuid} 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/cases/uuid' \
 --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) 
{
  "name": "finance",
  "slug": "finance",
  "type": {
    "name": "Mortgage Plan",
    "uuid": "8f4eabe8-0091-4f11-be08-b1e1e15c674d",
    "created_at": "2025-05-14T18:27:13+01:00",
    "updated_at": "2025-05-14T18:27:13+01:00"
  },
  "uuid": "bfcb486d-e8dd-4f74-adac-c04e20fae7e4",
  "plans": {
    "name": "Johns ISA",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "cash_account",
    "uuid": "0b8d5eee-1a57-463b-9c03-de6835345034",
    "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-05-14T18:27:13+01:00",
    "valued_at": "2025-05-14T18:27:13+01:00",
    "created_at": "2025-05-14T18:27:13+01:00",
    "statistics": {
      "recent_growth": 100
    },
    "updated_at": "2025-05-14T18:27:13+01:00",
    "advice_area": "non_investment_insurance",
    "inactive_at": "2025-05-14T18:27:13+01:00",
    "review_date": "2024-05-14",
    "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,
    "latest_valuations": "App\\Http\\Resources\\Plans\\ValuationResource",
    "original_valued_at": "2025-05-13T18:27:13+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-05-14",
    "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": "bc83b76c-8124-4127-97b5-bd8e84d42f22",
    "colour": "#23852B",
    "position": 5,
    "created_at": "2025-05-14T18:27:13+01:00",
    "updated_at": "2025-05-14T18:27:13+01:00"
  },
  "review_at": "2025-05-14T18:27:13+01:00",
  "created_at": "2025-05-14T18:27:13+01:00",
  "updated_at": "2025-05-14T18:27:13+01:00",
  "group_uuids": [
    "74e005eb-0625-44da-919b-b04e38489fa1"
  ],
  "completed_at": "2025-05-14T18:27:13+01:00",
  "participants": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "4eedd050-4ff4-4b77-b7e2-55b6ee2f8f1f",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-05-14T18:27:13+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-05-14T18:27:13+01:00",
    "with_login": true,
    "inactive_at": "2025-05-14",
    "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-05-14T18:27:13+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-05-14T18:27:13+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-05-14T18:27:13+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-05-14T18:27:13+01:00"
  },
  "custom_fields": [
    {
      "name": "Favourite Drink",
      "type": "string",
      "uuid": "65a07fb3-9614-4110-a964-827f7ecab4d3",
      "value": "Coffee",
      "help_text": "This is the client's favourite drink.",
      "reference": "favourite_drink",
      "created_at": "2025-05-14T18:27:13+01:00",
      "updated_at": "2025-05-14T18:27:13+01:00",
      "is_required": false,
      "selection_options": [
        "Coffee",
        "Tea",
        "Water"
      ]
    }
  ],
  "status_position": 4,
  "task_board_uuid": "53c60ae5-c6ee-48ee-be2d-d75b25af576e",
  "assigned_to_uuids": [
    "6aac7cf4-21ad-4098-a284-af12f88db691"
  ],
  "participants_count": 4
}