Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
Path parameters
-
uuid
string Required
GET
/api/v1/document/{uuid}
curl \
--request GET 'https://api.plannrcrm.com/api/v1/document/uuid' \
--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)
{
"name": "Welcome Template",
"uuid": "540fbf68-bfbf-4476-a4cb-8a05cf4a266a",
"status": "published",
"version": 3,
"created_at": "2025-06-04T16:49:36+01:00",
"updated_at": "2025-06-04T16:49:36+01:00",
"public_pdf_url": "https://plannr.valet/document/95db72d3-b269-4213-870c-8028f569d8e9/content/pdf?plannr_account_uuid=21efb3e9-9d02-488d-b95f-e4d313461021",
"public_docx_url": "https://plannr.valet/document/08446ac2-1c8f-46d7-9a4e-874a60390455/content/docx?plannr_account_uuid=24a50b30-8769-42c8-a321-cacf7b9964da",
"public_sfdt_url": "https://plannr.valet/document/9d06871d-1d71-4ef6-9c3f-0f67194904d4/content/sfdt?plannr_account_uuid=64c1a228-0ed4-48e0-a907-dcbf78babc05",
"known_dependants": {
"client-1": "e8ab6ff6-8437-42b3-b2cb-2c5ea117522a"
},
"public_preview_url": "https://plannr.valet/document/5924587a-1181-4e78-bc16-6b6c810d98de/content/preview?plannr_account_uuid=4badd3f5-bf73-43f9-9c69-692c3bfbc8cd",
"required_dependants": {
"client-1": "client"
},
"last_publishing_error": "There was an error converting this file to PDF. Please try again later."
}