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
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": "d89e43fb-12b1-442c-9818-e4c8ea4416a5",
      "status": "published",
      "version": 3,
      "created_at": "2024-10-16T11:10:15+01:00",
      "updated_at": "2024-10-16T11:10:15+01:00",
      "public_pdf_url": "https://plannr.valet/document/bb569e9b-3904-40fc-a028-149cdd206c5d/content/pdf?plannr_account_uuid=296250bf-df79-408e-aec9-b13f6398ba09",
      "public_docx_url": "https://plannr.valet/document/2ca6f130-abd0-4092-a0a1-b1c7a76ec0c4/content/docx?plannr_account_uuid=185c2bca-88b9-4531-98ae-b7ba258d85ea",
      "public_sfdt_url": "https://plannr.valet/document/62dd5484-36c3-4280-bfcd-7b30ec121b92/content/sfdt?plannr_account_uuid=f17da65d-0826-4f44-8676-c5bb915bcba5",
      "known_dependants": {
        "client-1": "af605737-b561-46a7-87b9-61d8b4448104"
      },
      "public_preview_url": "https://plannr.valet/document/4347a0a1-4d08-44c1-8733-eabf018663a2/content/preview?plannr_account_uuid=547df293-3dc3-4b57-a2ba-e6fab8792a5f",
      "required_dependants": {
        "client-1": "client"
      }
    }
  ]
}