Get all documents

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
      • created_at string
      • updated_at string
      • version integer
      • name string
      • status string
      • last_publishing_error string
      • required_dependants object
        Hide required_dependants attribute Show required_dependants attribute object
        • client-1 string
      • known_dependants object
        Hide known_dependants attribute Show known_dependants attribute object
        • client-1 string
      • public_docx_url string
      • public_sfdt_url string
      • public_pdf_url string
      • public_preview_url string
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": "30e0db3f-6e34-4182-9fa0-c57f312a02e3",
      "status": "published",
      "version": 3,
      "created_at": "2025-06-25T15:10:44+01:00",
      "updated_at": "2025-06-25T15:10:44+01:00",
      "public_pdf_url": "https://api.plannrcrm.com/document/c7016dd6-67e0-4f99-99ce-13454d3401e8/content/pdf?plannr_account_uuid=306216eb-47d5-4ecd-abc4-c7f3c5e751f4",
      "public_docx_url": "https://api.plannrcrm.com/document/490b5bd1-995e-437f-b58e-cc246b0749d7/content/docx?plannr_account_uuid=d3bb129c-1ae1-4c71-b081-9f73db198a0c",
      "public_sfdt_url": "https://api.plannrcrm.com/document/1aa9e6a9-0591-43c1-913b-9ab52d051f71/content/sfdt?plannr_account_uuid=ccb981c2-4304-419e-a6e9-60b1a7eb013a",
      "known_dependants": {
        "client-1": "88bbce2d-eb5f-4f2c-977a-fa74971aa29d"
      },
      "public_preview_url": "https://api.plannrcrm.com/document/dd998776-b0b1-4c33-9dad-a0ab7f064559/content/preview?plannr_account_uuid=e313a759-b6d2-43e5-8d3f-c12eaae32960",
      "required_dependants": {
        "client-1": "client"
      },
      "last_publishing_error": "There was an error converting this file to PDF. Please try again later."
    }
  ]
}