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

        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.

      • description string

        The description of the custom default folders structure.

      • model string

        The model the default folders structure is for.

      • parameter string

        The parameter the default folders structure is for.

      • case_type object

        The case type object when model is "case" and the parameter is a valid case type UUID.

        Hide case_type attributes Show case_type attributes object
        • uuid string
        • name string
        • created_at string
        • updated_at string
      • structure array[object]

        The default folders structure.

        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

        Whether the default folders structure is active.

      • for_existing boolean

        Whether the default folders structure is for existing clients.
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": "162a1c36-8535-4218-bd40-8b48d452a18a",
      "model": "client",
      "case_type": {
        "name": "Mortgage Plan",
        "uuid": "0bcee84d-b3dc-41ab-9ffb-924d0ecc20d9",
        "created_at": "2025-12-24T11:03:00+00:00",
        "updated_at": "2025-12-24T11:03:00+00:00"
      },
      "is_active": true,
      "parameter": "client",
      "structure": [
        {
          "name": "Documents",
          "children": [
            {
              "name": "Contracts",
              "children": []
            },
            {
              "name": "Emails",
              "children": []
            }
          ]
        },
        {
          "name": "Notes",
          "children": []
        }
      ],
      "created_at": "2025-12-24T11:03:00+00:00",
      "updated_at": "2025-12-24T11:03:00+00:00",
      "description": "Shared client default folders",
      "for_existing": true
    }
  ]
}