List Notes for a Participant

get/public/v1/participants/{participant}/notes

get/public/v1/participants/{participant}/notes

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

Response

{
  "data": [
    {
      "id": "n1o2t3e4-b5c6-47d8-9e0f-1a2b3c4d5e6f",
      "content": "Supported the participant with their morning routine.",
      "source_type": "support",
      "source": {
        "id": "string",
        "type": "string"
      },
      "author": {
        "id": "u1s2e3r4-b5c6-47d8-9e0f-1a2b3c4d5e6f",
        "name": "Jane Smith"
      },
      "checkin_type": "phone",
      "created_at": "2024-01-15T10:30:00+00:00",
      "updated_at": "2024-01-15T11:05:00+00:00"
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 0,
    "total": 0,
    "allowed_sorts": [
      "string"
    ]
  }
}

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

participantstringrequired
The participant UUID

Query parameters

filter[source]string
Filter by note source. One of: profile, support, task.
Example:support
filter[search]string
Partial match on the note content, or a date in d/m/Y format.
Example:medication
page[size]integer
Number of results per page. Minimum 1, maximum 100.
Default:25
page[number]integer
The page number to retrieve. Use the last_page value from the meta response to determine the total number of pages available.
Default:1

Response

200application/json

Paginated set of ParticipantNoteResource

dataobject[]required
▶Show 8 child attributesHide child attributes
- idstringrequired
  Example:n1o2t3e4-b5c6-47d8-9e0f-1a2b3c4d5e6f
- contentstringrequired
  Example:Supported the participant with their morning routine.
- source_typestringrequired
  Example:support
- sourceobject | nullrequired
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  typestring | nullrequired
- authorobject | null
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:u1s2e3r4-b5c6-47d8-9e0f-1a2b3c4d5e6f
  namestringrequired
  Example:Jane Smith
- checkin_typestring | nullrequired
  Example:phone
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00
- updated_atstringrequired
  Example:2024-01-15T11:05:00+00:00
metaobjectrequired
▶Show 5 child attributesHide child attributes
- current_pageintegerrequired≥ 1
- last_pageintegerrequired≥ 1
- per_pageintegerrequired≥ 0
  Number of items shown per page.
- totalintegerrequired≥ 0
  Total number of items being paginated.
- allowed_sortsstring[]required
  The list of allowed sorts for this endpoint.

Errors

401Unauthenticated
403Authorization error
404Not found

Command Palette

Authorization

Path parameters

Query parameters

Response

Errors