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": "0fb88cbd-8e88-4eee-bbad-bec634e8ea71",
"status": "published",
"version": 3,
"created_at": "2025-10-08T10:40:15+01:00",
"updated_at": "2025-10-08T10:40:15+01:00",
"public_pdf_url": "https://api.plannrcrm.com/document/e0da1382-b2ce-4a68-9f06-189acd828594/content/pdf?plannr_account_uuid=88324ad7-672b-4984-8876-59c77cdc5a1c",
"public_docx_url": "https://api.plannrcrm.com/document/74f67458-17c6-4750-ab90-6a1cbd88a93a/content/docx?plannr_account_uuid=4389c1d2-54e9-4914-bb27-5310c9efcd95",
"public_sfdt_url": "https://api.plannrcrm.com/document/cd570c85-a57d-40df-98dd-bcacc0dcd8ae/content/sfdt?plannr_account_uuid=496a6db4-e460-4d76-a663-d6d94db233c0",
"known_dependants": {
"client-1": "ea187fe5-8967-476f-9f67-88d7a0c55ce1"
},
"public_preview_url": "https://api.plannrcrm.com/document/db57ed26-7d35-46eb-b74d-d66b1f2f7de4/content/preview?plannr_account_uuid=660be7fa-0211-4197-a343-f601b7b4498e",
"required_dependants": {
"client-1": "client"
},
"last_publishing_error": "There was an error converting this file to PDF. Please try again later."
}
]
}