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.

  • 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": "903d9fed-9677-4028-9721-d88e4fb5fd28",
      "status": "published",
      "version": 3,
      "created_at": "2024-11-20T13:24:02+00:00",
      "updated_at": "2024-11-20T13:24:02+00:00",
      "public_pdf_url": "https://plannr.valet/document/fd384a40-c084-4e3d-914c-2a878ccdec3a/content/pdf?plannr_account_uuid=8f497adc-17ae-4fa2-91be-8c06ee42c74b",
      "public_docx_url": "https://plannr.valet/document/1f4e5de5-b390-4397-a4ea-e7366c54aa91/content/docx?plannr_account_uuid=c23ed655-a4c1-4300-9935-39489d236460",
      "public_sfdt_url": "https://plannr.valet/document/e0e3d7e2-b2e6-4d91-84c1-f2821dd757f6/content/sfdt?plannr_account_uuid=0d603917-24f1-4e0a-90a7-21591ec37de9",
      "known_dependants": {
        "client-1": "dad8f3b7-50ab-4c38-9a63-0d4db0c2ccc1"
      },
      "public_preview_url": "https://plannr.valet/document/c60f1417-f91f-4643-91fd-40ad3ce6f2ee/content/preview?plannr_account_uuid=bfbb6675-6aec-4ae2-9ace-40201a462bbd",
      "required_dependants": {
        "client-1": "client"
      }
    }
  ]
}