Get a custom default folder

GET /api/v1/custom-default-folder/{customDefaultFolder_uuid}

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.

      Additional properties are allowed.

    • structure array[object]

      The default folders structure.

      Additional properties are allowed.

    • 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 \
 -X GET https://api.plannrcrm.com/api/v1/custom-default-folder/customDefaultFolder_uuid \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (201) 
{
  "uuid": "5f8a5757-2cdc-4b59-a441-8918c47092bc",
  "model": "client",
  "case_type": {
    "name": "Mortgage Plan",
    "uuid": "b62dec5b-f6a4-4754-b795-a691a253f6a7",
    "created_at": "2025-01-17T11:18:33+00:00",
    "updated_at": "2025-01-17T11:18:33+00:00"
  },
  "is_active": true,
  "parameter": "client",
  "structure": [
    {
      "name": "Documents",
      "children": [
        {
          "name": "Contracts",
          "children": []
        },
        {
          "name": "Emails",
          "children": []
        }
      ]
    },
    {
      "name": "Notes",
      "children": []
    }
  ],
  "created_at": "2025-01-17T11:18:33+00:00",
  "updated_at": "2025-01-17T11:18:33+00:00",
  "description": "Shared client default folders",
  "for_existing": true
}