Headers
-
Content-Type string
-
Accept string
-
X-PLANNR-ACCOUNT-UUID string
Query parameters
-
include string
Comma separated list of relationships to include in the response. Valid relationships are [clients, file].
-
filter[uuid] string
Filter by a comma separated list of UUIDs.
-
filter[name] string
Filter by partial document title
-
filter[created_before] string
date Filter documents created before a given date. Format: YYYY-MM-DD
-
filter[created_after] string
date Filter documents created after a given date. Format: YYYY-MM-DD
-
filter[client_uuids] string
Filter by a comma separated list of client UUIDs.
-
filter[circle_uuids] string
Comma separated string of circle UUIDs to filter by.
-
sort string
Field to sort by. Valid fields are [created_at, updated_at]. Negative sign to denote DESC. Defaults to 'updated_at'.
-
per_page integer
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 {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)
{
"data": [
{
"name": "Welcome Template",
"uuid": "53f3fe67-1837-4cf4-b625-4dc483284934",
"status": "published",
"version": 3,
"created_at": "2025-02-20T10:13:03+00:00",
"updated_at": "2025-02-20T10:13:03+00:00",
"public_pdf_url": "https://plannr.valet/document/c6f973fc-8d28-4840-a21d-f8569c7a7a89/content/pdf?plannr_account_uuid=da0a0eee-9b25-41ed-9437-87073ec0b372",
"public_docx_url": "https://plannr.valet/document/d18ba14a-0216-453b-8de8-ab08ee0c1b35/content/docx?plannr_account_uuid=b95132c7-f83b-4e0b-af07-f398332b28cf",
"public_sfdt_url": "https://plannr.valet/document/261a4318-1480-4b46-852b-54ad629e2308/content/sfdt?plannr_account_uuid=3310a863-df48-4600-95d8-708cb6e683aa",
"known_dependants": {
"client-1": "93255316-dff0-461f-8700-3c52d509943b"
},
"public_preview_url": "https://plannr.valet/document/46e64097-c3b7-470a-9448-e52f8115afea/content/preview?plannr_account_uuid=83ae56f2-c0d2-43a0-9f09-15947c26139a",
"required_dependants": {
"client-1": "client"
}
}
]
}