Get all documents

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

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
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": "deb1c1ef-b6d6-41d2-b14b-8658c212bd97",
      "status": "published",
      "version": 3,
      "created_at": "2025-06-05T11:39:40+01:00",
      "updated_at": "2025-06-05T11:39:40+01:00",
      "public_pdf_url": "https://plannr.valet/document/ecbb4b78-e247-41da-8697-09a64931f1e7/content/pdf?plannr_account_uuid=1e852a73-9c97-4fad-b434-48e497074505",
      "public_docx_url": "https://plannr.valet/document/6f4786e1-bf87-4fbe-a35c-8e2464e6ef5e/content/docx?plannr_account_uuid=4d5cc8f8-5b28-4129-9e7f-f0357784c185",
      "public_sfdt_url": "https://plannr.valet/document/fcc79a0d-ae36-4261-814f-c93601a1558e/content/sfdt?plannr_account_uuid=8400f04d-aa8c-41c1-a268-c4c6e495f577",
      "known_dependants": {
        "client-1": "7c772463-f108-43cb-b617-2daf821f9f94"
      },
      "public_preview_url": "https://plannr.valet/document/3cb10238-4196-4fc2-afad-da4c7ef764f6/content/preview?plannr_account_uuid=74e81011-aebc-4590-9b1b-ee95954272e5",
      "required_dependants": {
        "client-1": "client"
      },
      "last_publishing_error": "There was an error converting this file to PDF. Please try again later."
    }
  ]
}