Get all custom default folders Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://apidocs.plannrcrm.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "PlannrCRM MCP server": {
    "url": "https://apidocs.plannrcrm.com/mcp"
  }
}

Close
GET /api/v1/custom-default-folder

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": "8a587098-ec74-462f-bf2e-3224bc811eea",
        "created_at": "2026-07-17T15:25:30+01:00",
        "updated_at": "2026-07-17T15:25:30+01:00",
        "description": "Shared client default folders",
        "model": "client",
        "parameter": "client",
        "case_type": {
          "uuid": "d0bd48c9-68a9-4c4f-9a99-5997a9d45d0f",
          "name": "Mortgage Plan",
          "created_at": "2026-07-17T15:25:30+01:00",
          "updated_at": "2026-07-17T15:25:30+01:00"
        },
        "structure": [
          {
            "name": "Documents",
            "children": [
              {
                "name": "Contracts",
                "children": []
              },
              {
                "name": "Emails",
                "children": []
              }
            ]
          },
          {
            "name": "Notes",
            "children": []
          }
        ],
        "is_active": true,
        "for_existing": true
      }
    ]
  ]
}