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": "9ef6d9f7-d012-4048-b9c8-c0a8da375107",
      "status": "published",
      "version": 3,
      "created_at": "2025-05-14T18:27:14+01:00",
      "updated_at": "2025-05-14T18:27:14+01:00",
      "public_pdf_url": "https://plannr.valet/document/e463e2b5-ae58-49c2-a79b-dc686dc11980/content/pdf?plannr_account_uuid=c4351652-f2a4-47af-b375-4f573f3a7704",
      "public_docx_url": "https://plannr.valet/document/4ed505a0-2e6c-4fd0-9c4f-becc5970e134/content/docx?plannr_account_uuid=08bd0964-198c-4454-b153-2764132d9363",
      "public_sfdt_url": "https://plannr.valet/document/1df01bfc-dc1f-492a-9acf-54e32f5c7fc8/content/sfdt?plannr_account_uuid=5a94b106-d864-43ee-b813-7d846f267d67",
      "known_dependants": {
        "client-1": "b468da7c-7a00-4b59-ac5d-9ec951360ba9"
      },
      "public_preview_url": "https://plannr.valet/document/9af36f6d-488e-4c88-9486-77456b6a5aec/content/preview?plannr_account_uuid=9b171dde-69ef-4a7c-8bf2-90af929cd435",
      "required_dependants": {
        "client-1": "client"
      },
      "last_publishing_error": "There was an error converting this file to PDF. Please try again later."
    }
  ]
}