Get a Generated Document

get/public/v1/generated-documents/{generatedDocument}

get/public/v1/generated-documents/{generatedDocument}

curl --request GET \
  --url 'https://api.app.astalty.com.au/public/v1/generated-documents/{generatedDocument}' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json'

Response

{
  "data": {
    "id": "g1e2n3d4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
    "name": "Support Plan - Jane Citizen",
    "status": "draft",
    "type": "rich_text",
    "template_name": "Support Plan",
    "content": "<p>Jane's goals for the next 12 months.</p>",
    "finalised_at": "2024-01-16T09:00:00+00:00",
    "created_at": "2024-01-15T10:30:00+00:00",
    "updated_at": "2024-01-15T11:05:00+00:00"
  }
}

Authorization

Authorizationstringrequired
Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Path parameters

generatedDocumentstringrequired
The generated document UUID

Response

200application/json

GeneratedDocumentResource

dataobjectrequired
▶Show 9 child attributesHide child attributes
- idstringrequired
  Example:g1e2n3d4-a5b6-47c8-9d0e-1f2a3b4c5d6e
- namestringrequired
  Example:Support Plan - Jane Citizen
- statusenum<string>required
  Available options:draftfinalised
- typeenum<string>required
  Available options:rich_textword
- template_namestring | nullrequired
  Example:Support Plan
- contentstring | nullrequired
  Example:<p>Jane's goals for the next 12 months.</p>
- finalised_atstring | nullrequired
  Example:2024-01-16T09:00:00+00:00
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00
- updated_atstringrequired
  Example:2024-01-15T11:05:00+00:00

Errors

401Unauthenticated
403Authorization error
404Not found