Get all documents

GET /api/v1/document

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]

      Additional properties are allowed.
GET /api/v1/document 
curl \
 -X GET https://api.plannrcrm.com/api/v1/document \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}"
Response examples (200) 
{
  "data": [
    {
      "name": "Welcome Template",
      "uuid": "d577787d-826a-4a9d-bb47-272d1efd008c",
      "status": "published",
      "version": 3,
      "created_at": "2025-01-17T11:18:31+00:00",
      "updated_at": "2025-01-17T11:18:31+00:00",
      "public_pdf_url": "https://plannr.valet/document/f5cf0f7e-73f1-4fee-b3d5-73ef88de118b/content/pdf?plannr_account_uuid=64e81609-c7c5-4b22-b364-c965168a30f1",
      "public_docx_url": "https://plannr.valet/document/a5e2a727-f619-416d-9113-344e8ab64b91/content/docx?plannr_account_uuid=fbf59d3f-d4e4-43aa-b764-deb92ed430d7",
      "public_sfdt_url": "https://plannr.valet/document/2470643c-d1c2-4f05-bed3-16a2a4d4eaeb/content/sfdt?plannr_account_uuid=07ac596e-d861-4b7c-bd4f-cba237749c60",
      "known_dependants": {
        "client-1": "40d78ec5-941e-44f3-a5fe-019efc2f64ad"
      },
      "public_preview_url": "https://plannr.valet/document/8faae1ec-0a32-4390-9c2b-db197b6fe3a3/content/preview?plannr_account_uuid=ed870ee1-70d8-4c25-b37d-3cb6ed229a99",
      "required_dependants": {
        "client-1": "client"
      }
    }
  ]
}