Get all custom default folders

GET /api/v1/custom-default-folder
Personal access token & O auth2

Headers

  • X-PLANNR-ACCOUNT-UUID string

Query parameters

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • filter[model] string

    Filter by model type. Valid types are [client, case, plan]

  • filter[is_active] boolean

    Filter only active custom default folders

  • 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]. Negative sign to denote DESC. Defaults to '-created_at'.

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
      • description string
      • model string
      • parameter string
      • case_type object
        Hide case_type attributes Show case_type attributes object
        • uuid string
        • name string
        • created_at string
        • updated_at string
      • structure array[object]
        Hide structure attributes Show structure attributes object
        • name string
        • children array[object]
          Hide children attributes Show children attributes object
          • name string
          • children array
      • is_active boolean
      • for_existing boolean
GET /api/v1/custom-default-folder 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/custom-default-folder' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "uuid": "6a5cedc1-de46-44d8-8c9a-ee777d621835",
      "model": "client",
      "case_type": {
        "name": "Mortgage Plan",
        "uuid": "afeb74bb-1578-44eb-be30-b1d339ee9ce1",
        "created_at": "2025-06-25T15:10:48+01:00",
        "updated_at": "2025-06-25T15:10:48+01:00"
      },
      "is_active": true,
      "parameter": "client",
      "structure": [
        {
          "name": "Documents",
          "children": [
            {
              "name": "Contracts",
              "children": []
            },
            {
              "name": "Emails",
              "children": []
            }
          ]
        },
        {
          "name": "Notes",
          "children": []
        }
      ],
      "created_at": "2025-06-25T15:10:48+01:00",
      "updated_at": "2025-06-25T15:10:48+01:00",
      "description": "Shared client default folders",
      "for_existing": true
    }
  ]
}