Get a document

GET /api/v1/document/{uuid}
Personal access token & O auth2

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • uuid string

      The UUID of the resource.

    • created_at string

      The timestamp of when the resource was created.

    • updated_at string

      The timestamp of when the resource was updated.

    • version integer

      The document builder version. Used for internal purposes only. Defaults to 3

    • name string

      The name of the document.

    • status string

      The status of the document.

    • last_publishing_error string

      The last error that occured during publishing.

    • required_dependants object

      The required dependant variables of the document.

    • known_dependants object

      The dependants submitted to the document previously.

    • public_docx_url string

      The download URL of the DOCX content. This is intended for the user to download if they are signed into Plannr. You can access this data via the API using the route in /api/v1.

    • public_sfdt_url string

      The download URL of the SFDT (SyncFusion) content. This is intended for the user to download if they are signed into Plannr. You can access this data via the API using the route in /api/v1.

    • public_pdf_url string

      The download URL of the PDF content. This is intended for the user to download if they are signed into Plannr. You can access this data via the API using the route in /api/v1.

    • public_preview_url string

      The image preview URL of the document. This is intended for the user to preview the document before opening it. You can access this data via the API using the route in /api/v1.
GET /api/v1/document/{uuid} 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/document/uuid' \
 --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) 
{
  "name": "Welcome Template",
  "uuid": "cc2fb17b-bf55-49f0-9a2c-23c547ffb377",
  "status": "published",
  "version": 3,
  "created_at": "2025-04-22T13:44:19+01:00",
  "updated_at": "2025-04-22T13:44:19+01:00",
  "public_pdf_url": "https://plannr.valet/document/09cfa8b1-3730-42a5-8f5a-dbc8134d84b5/content/pdf?plannr_account_uuid=9644267c-cec3-4905-b021-c2cd03bf0dc4",
  "public_docx_url": "https://plannr.valet/document/3797abb4-8fb5-43bc-abd5-69a252727525/content/docx?plannr_account_uuid=74a8b3d6-4046-441f-a7f4-4978cc914dec",
  "public_sfdt_url": "https://plannr.valet/document/44aeebe2-a66f-45ae-95fd-f429719db1aa/content/sfdt?plannr_account_uuid=ea4ced6e-d4b2-4fdf-b826-f92b224bb2b6",
  "known_dependants": {
    "client-1": "0a5ff1a0-a9b4-41fb-812e-50726e43f50f"
  },
  "public_preview_url": "https://plannr.valet/document/8f8f77d6-d16f-4b65-9df4-a90a10e6275f/content/preview?plannr_account_uuid=879eb1d3-5b83-4f73-b1a7-a5affd61de8d",
  "required_dependants": {
    "client-1": "client"
  },
  "last_publishing_error": "There was an error converting this file to PDF. Please try again later."
}