Get all documents
Headers
-
Content-Type string
-
Accept string
-
X-PLANNR-ACCOUNT-UUID string
Query parameters
-
include string
Comma separated list of relationships to include in the response. Valid relationships are [clients, file].
-
filter[uuid] string
Filter by a comma separated list of UUIDs.
-
filter[name] string
Filter by partial document title
-
filter[created_before] string
date Filter documents created before a given date. Format: YYYY-MM-DD
-
filter[created_after] string
date Filter documents created after a given date. Format: YYYY-MM-DD
-
filter[client_uuids] string
Filter by a comma separated list of client UUIDs.
-
filter[circle_uuids] string
Comma separated string of circle UUIDs to filter by.
-
sort string
Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC. Defaults to 'updated_at'.
-
per_page integer
Number of results to return with pagination (Default 15. Max 500).
GET
/api/v1/document
curl \
-X GET https://api.plannrcrm.com/api/v1/document \
-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": [
{
"name": "Welcome Template",
"uuid": "a4c20430-7d76-499d-ad3b-96c151372c82",
"status": "published",
"version": 3,
"created_at": "2025-01-21T09:11:10+00:00",
"updated_at": "2025-01-21T09:11:10+00:00",
"public_pdf_url": "https://plannr.valet/document/7ff46a75-38e2-4ebd-9002-280033e3af84/content/pdf?plannr_account_uuid=a0543147-ee05-4d99-ad76-ef7548816d29",
"public_docx_url": "https://plannr.valet/document/aa580bfe-a3dc-40cd-bdae-04159aaee3d6/content/docx?plannr_account_uuid=0f359a31-6dc6-4ba7-adb3-c82e3cc08927",
"public_sfdt_url": "https://plannr.valet/document/7c835487-e74c-4c19-aa86-ed9d1d62a563/content/sfdt?plannr_account_uuid=36c4d991-4b28-4825-b274-1ce1397ab6e0",
"known_dependants": {
"client-1": "2037640a-4040-4755-b66f-e1d3d00195aa"
},
"public_preview_url": "https://plannr.valet/document/0036e927-211a-4f86-a689-b8b68c11fec1/content/preview?plannr_account_uuid=64d51a94-d599-4816-bc26-719d6fba75ef",
"required_dependants": {
"client-1": "client"
}
}
]
}