Headers
-
Content-Type string
-
Accept string
-
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'.
GET
/api/v1/custom-default-folder
curl \
--request GET https://api.plannrcrm.com/api/v1/custom-default-folder \
--header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
"data": [
{
"uuid": "81a7022a-11b3-4e65-bd07-0054ded45382",
"model": "client",
"case_type": {
"name": "Mortgage Plan",
"uuid": "fee09e9f-65a9-4ce1-b659-56ff6f5fece3",
"created_at": "2025-02-20T10:13:06+00:00",
"updated_at": "2025-02-20T10:13:06+00:00"
},
"is_active": true,
"parameter": "client",
"structure": [
{
"name": "Documents",
"children": [
{
"name": "Contracts",
"children": []
},
{
"name": "Emails",
"children": []
}
]
},
{
"name": "Notes",
"children": []
}
],
"created_at": "2025-02-20T10:13:06+00:00",
"updated_at": "2025-02-20T10:13:06+00:00",
"description": "Shared client default folders",
"for_existing": true
}
]
}