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": "7cf5dfe9-556f-4270-a69f-911713933ae0",
      "status": "published",
      "version": 3,
      "created_at": "2025-04-22T13:44:19+01:00",
      "updated_at": "2025-04-22T13:44:19+01:00",
      "public_pdf_url": "https://plannr.valet/document/34a78b91-7c2c-422a-a486-6fcaad703be6/content/pdf?plannr_account_uuid=28accea5-38b3-4866-b92c-bed0c755380a",
      "public_docx_url": "https://plannr.valet/document/6aefd5bf-cc01-4661-ac8f-0891ad10ac36/content/docx?plannr_account_uuid=4250eb14-186c-4d22-998a-475fe7c5ddac",
      "public_sfdt_url": "https://plannr.valet/document/109decf2-3a02-42c9-9087-79852d64dc32/content/sfdt?plannr_account_uuid=9bf556ad-64a5-4390-a9ca-34aa4df13010",
      "known_dependants": {
        "client-1": "d3218260-ba72-40e9-ae65-c81c30b807a3"
      },
      "public_preview_url": "https://plannr.valet/document/e812cee3-3416-4c14-86a8-6b3880749fe3/content/preview?plannr_account_uuid=90355ca8-8f76-45e6-ab8e-85cf05c9f981",
      "required_dependants": {
        "client-1": "client"
      },
      "last_publishing_error": "There was an error converting this file to PDF. Please try again later."
    }
  ]
}