Get a Note Template

get/public/v1/note-templates/{noteTemplate}

get/public/v1/note-templates/{noteTemplate}

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

Response

{
  "data": {
    "id": "n1o2t3e4-t5e6-47m8-9p0l-1b2c3d4e5f6g",
    "name": "Initial Assessment",
    "content": "<p>Assessment notes for the participant.</p>",
    "usage": "participant_notes",
    "created_at": "2024-01-15T10:30: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

noteTemplatestringrequired
The note template UUID

Response

200application/json

NoteTemplateResource

dataobjectrequired
▶Show 5 child attributesHide child attributes
- idstringrequired
  Example:n1o2t3e4-t5e6-47m8-9p0l-1b2c3d4e5f6g
- namestringrequired
  Example:Initial Assessment
- contentstringrequired
  Example:<p>Assessment notes for the participant.</p>
- usagestring | nullrequired
  Example:participant_notes
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00

Errors

401Unauthenticated
403Authorization error
404Not found