Retrieve a Life Stage for a Firm

GET /api/v1/life-stage/{lifeStage_uuid}

Path parameters

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • uuid string

      uuid of the Expenditure Life Stage

    • name string

      The name of the Expenditure Life Stage. This is the name that will be displayed to the client. Example: "Survivor’s Lifestyle"

    • position string

      The expected position of the Expenditure Life Stage in any listing of the Expenditure Life Stages. The first Expenditure Life Stage should have a position of 1, the second 2, etc.

    • start_age string

      The expected age of the client as they enter the Expenditure Life Stage. This field is not required and may be null.

    • end_age string

      The expected age of the client as they mature beyond this Expenditure Life Stage. This field is not required and may be null.

    • sections object

      Array containing the Expenditure Life Stage Sections that will be displayed to the client. Including any Expenditure Life Stage fields associated with the section.

    • created_at string

      timestamp of when the Expenditure Life Stage was created

    • updated_at string

      timestamp of when the Expenditure Life Stage was updated
GET /api/v1/life-stage/{lifeStage_uuid} 
curl \
 -X GET https://api.plannrcrm.com/api/v1/life-stage/dcf0-484e-a0c5-08590fe89a84-f6aa1670 \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json"
Response examples (200) 
{
  "name": "Current Lifestyle",
  "uuid": "\"c538220f-6bcd-4112-834b-632a0e82fe33",
  "end_age": "28",
  "position": "1",
  "sections": {
    "name": "House Keeping",
    "uuid": "be37c8cd-d751-4592-bbe9-88d1b8db0e6a",
    "fields": "App\\Http\\Resources\\LifeStageFieldResource",
    "position": "1",
    "created_at": "2023-06-16T15:25:06+01:00",
    "updated_at": "2023-06-16T15:25:06+01:00"
  },
  "start_age": "21",
  "created_at": "2023-06-16T15:25:06+01:00",
  "updated_at": "2023-06-16T15:25:06+01:00"
}