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": "8b43d435-d89f-4091-a460-78a9c5b0cafb",
"status": "published",
"version": 3,
"created_at": "2025-08-27T17:31:26+01:00",
"updated_at": "2025-08-27T17:31:26+01:00",
"public_pdf_url": "https://api.plannrcrm.com/document/848a6445-73ac-4cb7-8ef5-f0176a90bcdd/content/pdf?plannr_account_uuid=fc146341-218f-46c8-8094-99267c92c413",
"public_docx_url": "https://api.plannrcrm.com/document/936e4f53-6ebd-4dc7-bb13-8e5a6ecc3429/content/docx?plannr_account_uuid=3189d53b-4521-4abc-886a-c2abfe537284",
"public_sfdt_url": "https://api.plannrcrm.com/document/961ddc10-533b-4a97-9791-2b3be2bd2812/content/sfdt?plannr_account_uuid=278a0dde-8348-46c1-b0e4-6ac670363d99",
"known_dependants": {
"client-1": "664e159a-0e4a-41d7-80f5-b6164bfd8c6e"
},
"public_preview_url": "https://api.plannrcrm.com/document/72d1e3bc-889f-4618-8075-78c108bf93ca/content/preview?plannr_account_uuid=c28309a3-802f-4cf0-8c82-0a900a58c13a",
"required_dependants": {
"client-1": "client"
},
"last_publishing_error": "There was an error converting this file to PDF. Please try again later."
}
]
}