Query parameters
-
Comma separated list of relationships to include in the response. Valid relationships are [clients, file].
-
Filter by a comma separated list of UUIDs.
-
Filter by partial document title
-
date Filter documents created before a given date. Format: YYYY-MM-DD
-
date Filter documents created after a given date. Format: YYYY-MM-DD
-
Filter by a comma separated list of client UUIDs.
-
Comma separated string of circle UUIDs to filter by.
-
Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC. Defaults to 'updated_at'.
-
Number of results to return with pagination (Default 15. Max 500).
GET
/api/v1/document
curl \
--request GET 'https://api.plannrcrm.com/api/v1/document' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200)
{
"data": [
{
"name": "Welcome Template",
"uuid": "8a1adcb1-a2ec-4291-8eb4-f5fab6cf061a",
"status": "published",
"version": 3,
"created_at": "2025-08-07T13:41:43+01:00",
"updated_at": "2025-08-07T13:41:43+01:00",
"public_pdf_url": "https://api.plannrcrm.com/document/2abb7b7d-8361-4213-b59d-2fa5b3ffaf09/content/pdf?plannr_account_uuid=68da498c-0074-4c93-bcea-798543ea2f8a",
"public_docx_url": "https://api.plannrcrm.com/document/110c8af9-cec2-4b89-aa46-85a448bf59ca/content/docx?plannr_account_uuid=a799b54e-949f-4d30-a0e9-e7d501fee523",
"public_sfdt_url": "https://api.plannrcrm.com/document/2ca79981-e1de-462a-984b-97fa46f97ff9/content/sfdt?plannr_account_uuid=9ae3cd0c-cb7f-4908-8762-4626ba457064",
"known_dependants": {
"client-1": "b5eadc22-2eb4-4ba6-a14c-749799079595"
},
"public_preview_url": "https://api.plannrcrm.com/document/9d692902-4c7c-4f2e-81a3-ccb0bfed833d/content/preview?plannr_account_uuid=cb5a2610-b78a-44f7-be12-47d8c48ce0c8",
"required_dependants": {
"client-1": "client"
},
"last_publishing_error": "There was an error converting this file to PDF. Please try again later."
}
]
}