Get a custom default folder Run in API Explorer

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

Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • customDefaultFolder_uuid string Required

Responses

  • 201 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.

    • 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/{customDefaultFolder_uuid} 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/custom-default-folder/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (201) 
{
  "uuid": "f52429cf-a3da-406b-8459-d96a26f3b153",
  "model": "client",
  "case_type": {
    "name": "Mortgage Plan",
    "uuid": "c7322f77-829d-4bf7-9316-ad226e2edca5",
    "created_at": "2025-11-17T21:14:40+00:00",
    "updated_at": "2025-11-17T21:14:40+00:00"
  },
  "is_active": true,
  "parameter": "client",
  "structure": [
    {
      "name": "Documents",
      "children": [
        {
          "name": "Contracts",
          "children": []
        },
        {
          "name": "Emails",
          "children": []
        }
      ]
    },
    {
      "name": "Notes",
      "children": []
    }
  ],
  "created_at": "2025-11-17T21:14:40+00:00",
  "updated_at": "2025-11-17T21:14:40+00:00",
  "description": "Shared client default folders",
  "for_existing": true
}