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

        The UUID of the resource.

      • created_at string

        The timestamp of when the resource was created.

      • updated_at string

        The timestamp of when the resource was updated.

      • version integer

        The document builder version. Used for internal purposes only. Defaults to 3

      • name string

        The name of the document.

      • status string

        The status of the document.

      • last_publishing_error string

        The last error that occurred during publishing.

      • required_dependants object

        The required dependant variables of the document.

        Hide required_dependants attribute Show required_dependants attribute object
        • client-1 string
      • known_dependants object

        The dependants submitted to the document previously.

        Hide known_dependants attribute Show known_dependants attribute object
        • client-1 string
      • public_docx_url string

        The download URL of the DOCX content. This is intended for the user to download if they are signed into Plannr. You can access this data via the API using the route in /api/v1.

      • public_sfdt_url string

        The download URL of the SFDT (SyncFusion) content. This is intended for the user to download if they are signed into Plannr. You can access this data via the API using the route in /api/v1.

      • public_pdf_url string

        The download URL of the PDF content. This is intended for the user to download if they are signed into Plannr. You can access this data via the API using the route in /api/v1.

      • public_preview_url string

        The image preview URL of the document. This is intended for the user to preview the document before opening it. You can access this data via the API using the route in /api/v1.
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": "00673698-8b0e-4246-9a9e-d7b24d1aa32e",
      "status": "published",
      "version": 3,
      "created_at": "2025-12-24T11:02:59+00:00",
      "updated_at": "2025-12-24T11:02:59+00:00",
      "public_pdf_url": "https://api.plannrcrm.com/document/4aaabced-514d-4261-bb09-d5717121eb6f/content/pdf?plannr_account_uuid=9f372716-bdb9-4364-a875-7a67c0016bc8",
      "public_docx_url": "https://api.plannrcrm.com/document/19ade5de-aa15-4d98-9526-d94346ae2515/content/docx?plannr_account_uuid=bd09b0aa-1566-4216-9228-f1db6febd27d",
      "public_sfdt_url": "https://api.plannrcrm.com/document/c1adebb5-d8a4-4a1d-a25b-0cc0f9a73340/content/sfdt?plannr_account_uuid=d7510a10-17bb-4398-835b-c28bd8686d56",
      "known_dependants": {
        "client-1": "429207c6-6a77-410e-a257-46094f7dfd87"
      },
      "public_preview_url": "https://api.plannrcrm.com/document/f9792ac5-6bbc-4d93-b094-ac0069e2c427/content/preview?plannr_account_uuid=1a2dd37d-9518-433f-9fa0-e4d65506cb10",
      "required_dependants": {
        "client-1": "client"
      },
      "last_publishing_error": "There was an error converting this file to PDF. Please try again later."
    }
  ]
}