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": "17aa338a-ed7b-48c6-9c32-a289bcea29b9",
"status": "published",
"version": 3,
"created_at": "2025-04-02T13:27:56+01:00",
"updated_at": "2025-04-02T13:27:56+01:00",
"public_pdf_url": "https://plannr.valet/document/c8d6cf22-3762-4fad-bebf-3e19eed2c108/content/pdf?plannr_account_uuid=2e7eb77a-aa67-453c-b15c-abcd965bb873",
"public_docx_url": "https://plannr.valet/document/68247481-8081-40fc-bc30-9c5081d8a542/content/docx?plannr_account_uuid=572f2c5b-f5ba-4385-8c00-7e5d9ee4a37c",
"public_sfdt_url": "https://plannr.valet/document/017e93f5-866a-4aa9-b8eb-083ffa3f2ef6/content/sfdt?plannr_account_uuid=d6a1a7af-a8b5-470c-baa9-d82bc1309552",
"known_dependants": {
"client-1": "dd711456-cd68-438f-9e6f-c90537a516ca"
},
"public_preview_url": "https://plannr.valet/document/e31033ac-dfb5-4981-84bc-00764aa1726d/content/preview?plannr_account_uuid=41ab8af9-7b11-4a30-9f9b-31d0b215d7f9",
"required_dependants": {
"client-1": "client"
},
"last_publishing_error": "There was an error converting this file to PDF. Please try again later."
}