Get all custom default folders

GET /api/v1/custom-default-folder

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]

      Additional properties are allowed.
GET /api/v1/custom-default-folder 
curl \
 -X GET https://api.plannrcrm.com/api/v1/custom-default-folder \
 -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 (200) 
{
  "data": [
    {
      "uuid": "8beb6237-b5a0-4ce5-b9f1-2289370cf59a",
      "model": "client",
      "case_type": {
        "name": "Mortgage Plan",
        "uuid": "41691bd2-f6f1-4990-9fbe-e999b0aa7ff1",
        "created_at": "2024-11-20T13:24:04+00:00",
        "updated_at": "2024-11-20T13:24:04+00:00"
      },
      "is_active": true,
      "parameter": "client",
      "structure": [
        {
          "name": "Documents",
          "children": [
            {
              "name": "Contracts",
              "children": []
            },
            {
              "name": "Emails",
              "children": []
            }
          ]
        },
        {
          "name": "Notes",
          "children": []
        }
      ],
      "created_at": "2024-11-20T13:24:04+00:00",
      "updated_at": "2024-11-20T13:24:04+00:00",
      "description": "Shared client default folders",
      "for_existing": true
    }
  ]
}