Get all documents

GET /api/v1/document
Personal access token & O auth2

Headers

  • 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).

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • data array[object]
      Hide data attributes Show data attributes object
      • uuid string
      • created_at string
      • updated_at string
      • version integer
      • name string
      • status string
      • last_publishing_error string
      • required_dependants object
        Hide required_dependants attribute Show required_dependants attribute object
        • client-1 string
      • known_dependants object
        Hide known_dependants attribute Show known_dependants attribute object
        • client-1 string
      • public_docx_url string
      • public_sfdt_url string
      • public_pdf_url string
      • public_preview_url string
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": "010e4851-ab7d-46d6-8448-475b5ea72e69",
      "status": "published",
      "version": 3,
      "created_at": "2025-09-17T15:46:52+01:00",
      "updated_at": "2025-09-17T15:46:52+01:00",
      "public_pdf_url": "https://api.plannrcrm.com/document/b067d5c1-d4ba-4f87-a302-1bcb5a169184/content/pdf?plannr_account_uuid=0b072e27-b50a-4904-84e3-efa469b5d78b",
      "public_docx_url": "https://api.plannrcrm.com/document/92e5a1d8-17d3-4cca-acce-34808a2dcad1/content/docx?plannr_account_uuid=6f333dca-b8b1-448e-aad4-69f9888aa2cd",
      "public_sfdt_url": "https://api.plannrcrm.com/document/f3877da4-c1e0-44d6-92d9-b517d8782b4f/content/sfdt?plannr_account_uuid=d15b3fbd-58b1-49ef-b1fa-e24b03c5207b",
      "known_dependants": {
        "client-1": "ce4bb02c-9248-43ba-b451-ef14123785f9"
      },
      "public_preview_url": "https://api.plannrcrm.com/document/3c881d1a-3fca-4074-a11c-dfd8b00bef7d/content/preview?plannr_account_uuid=23eed227-bfc4-4e69-a890-529fd239e121",
      "required_dependants": {
        "client-1": "client"
      },
      "last_publishing_error": "There was an error converting this file to PDF. Please try again later."
    }
  ]
}