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": "96951f69-b14b-49bc-9603-3616e35713ee",
"status": "published",
"version": 3,
"created_at": "2025-10-24T10:34:19+01:00",
"updated_at": "2025-10-24T10:34:19+01:00",
"public_pdf_url": "https://api.plannrcrm.com/document/4972fe66-fb80-4602-aa97-6e37a2f3e7f9/content/pdf?plannr_account_uuid=f194d64c-182d-4683-bb67-45075d2ef73e",
"public_docx_url": "https://api.plannrcrm.com/document/f59f82e9-f1f6-459a-800b-3c7f329be0f4/content/docx?plannr_account_uuid=9680e9e2-62f4-4305-ba4b-97b9e816ddfb",
"public_sfdt_url": "https://api.plannrcrm.com/document/b5baab2f-fcc9-4a8b-b068-85870d7d7afd/content/sfdt?plannr_account_uuid=a4173506-1c9c-479d-9a7b-ce1481af7c55",
"known_dependants": {
"client-1": "22f475fb-422c-4034-b857-9032e3169ebe"
},
"public_preview_url": "https://api.plannrcrm.com/document/f189d905-80a8-4ae8-9ee6-25a85dcc4872/content/preview?plannr_account_uuid=e2fa031f-28c7-4f31-9d58-12ca47c6bea5",
"required_dependants": {
"client-1": "client"
},
"last_publishing_error": "There was an error converting this file to PDF. Please try again later."
}
]
}