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": "6dcb5d04-1e2e-4c95-97a3-df42f2dfc91a",
      "status": "published",
      "version": 3,
      "created_at": "2025-06-13T16:58:58+01:00",
      "updated_at": "2025-06-13T16:58:58+01:00",
      "public_pdf_url": "https://plannr.valet/document/a29c2cbc-d884-49be-8290-7dc6e72cf2bd/content/pdf?plannr_account_uuid=9fd18b0c-b89f-4b20-a29c-2864431f36e8",
      "public_docx_url": "https://plannr.valet/document/c7be4dde-496c-445d-97c6-37b77bdee9c1/content/docx?plannr_account_uuid=f61336a5-f89c-45c0-a193-026b03dfbf8a",
      "public_sfdt_url": "https://plannr.valet/document/e524033e-367f-4a3f-af1e-d9d779f48d54/content/sfdt?plannr_account_uuid=4e137231-0aca-470b-9918-fa4f13f36903",
      "known_dependants": {
        "client-1": "ff036eb5-c54c-4e78-b13d-d472c8c1562b"
      },
      "public_preview_url": "https://plannr.valet/document/00385305-5df2-4bab-b831-91a40f937eec/content/preview?plannr_account_uuid=192d55e4-4221-4e23-b870-425758797d47",
      "required_dependants": {
        "client-1": "client"
      },
      "last_publishing_error": "There was an error converting this file to PDF. Please try again later."
    }
  ]
}