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": "22cd5f38-17b6-4439-a6f7-1a6d449bfb3c",
      "status": "published",
      "version": 3,
      "created_at": "2025-04-02T13:27:56+01:00",
      "updated_at": "2025-04-02T13:27:56+01:00",
      "public_pdf_url": "https://plannr.valet/document/54dbabe3-9998-4231-b232-0776e0b854a1/content/pdf?plannr_account_uuid=b591a970-f651-4968-b032-95528d2ad045",
      "public_docx_url": "https://plannr.valet/document/ec2258dd-d75d-4192-9d92-8c7d666fa73b/content/docx?plannr_account_uuid=ee0b3646-edae-4b4c-87b1-19dde04def7d",
      "public_sfdt_url": "https://plannr.valet/document/4929c1ea-e359-4b96-af3e-fe04ef0dfb3e/content/sfdt?plannr_account_uuid=8bcb4aac-afb7-4ffe-bd0b-fa17a1d350c7",
      "known_dependants": {
        "client-1": "eb07974a-3b4a-4818-bc6d-5463f1e0ee8c"
      },
      "public_preview_url": "https://plannr.valet/document/4c5c6b47-da00-4289-8edf-5a7d268d7f07/content/preview?plannr_account_uuid=c0ef604b-dfc4-4e25-9e81-7a8ea10e2c3c",
      "required_dependants": {
        "client-1": "client"
      },
      "last_publishing_error": "There was an error converting this file to PDF. Please try again later."
    }
  ]
}