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": "97ae837c-c3d7-4737-99ae-a0f73b92dd49",
"status": "published",
"version": 3,
"created_at": "2025-06-24T10:15:13+01:00",
"updated_at": "2025-06-24T10:15:13+01:00",
"public_pdf_url": "https://plannr.valet/document/cb414d58-99de-4dee-becb-d936dbb43c41/content/pdf?plannr_account_uuid=0dc221b6-a812-4009-9f75-01d746448d1a",
"public_docx_url": "https://plannr.valet/document/51e5d00c-0d53-4f7e-80d0-16011863f07a/content/docx?plannr_account_uuid=692b29e4-2ec7-436e-907d-14a2ae10b1cc",
"public_sfdt_url": "https://plannr.valet/document/87f84eb5-6b9e-4f8f-9618-adfa9b5358ee/content/sfdt?plannr_account_uuid=f61eff62-3ff4-4e92-b1a8-75bf8a8ec4cf",
"known_dependants": {
"client-1": "9c0b973a-37a6-4289-b18e-a7454d9dd092"
},
"public_preview_url": "https://plannr.valet/document/9796fc09-4be6-4de4-8b0f-798376cda76c/content/preview?plannr_account_uuid=b208a6d0-4387-43f7-9620-8dd8f48d933d",
"required_dependants": {
"client-1": "client"
},
"last_publishing_error": "There was an error converting this file to PDF. Please try again later."
}