List Information Items for a Participant

get/public/v1/participants/{participant}/information-items

get/public/v1/participants/{participant}/information-items

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

Response

{
  "data": [
    {
      "id": "i1n2f3o4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
      "detail": "Medication details for participant",
      "created_at": "2024-01-15T10:30:00+00:00",
      "updated_at": "2024-06-02T09:15:00+00:00",
      "info_item": {
        "id": "i1t2e3m4-d5e6-47f8-9a0b-1c2d3e4f5a6b",
        "name": "Emergency Contact",
        "required": true,
        "documents_allowed": true,
        "visible_to_support_workers": false
      },
      "documents": [
        {
          "id": "d1c2e3f4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
          "name": "Service Agreement",
          "file_extension": "pdf",
          "created_at": "2024-01-15T10:30:00+00:00",
          "categories": [
            {
              "id": "c4a5b6c7-d8e9-40f1-a2b3-c4d5e6f7a8b9",
              "name": "Assessments"
            }
          ]
        }
      ]
    }
  ],
  "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[updated_at:before]string
Only return information items last updated before this date. Format YYYY-MM-DD, read as whole days in the provider's timezone rather than UTC.
Example:2025-09-20
filter[updated_at:on]string
Only return information items last updated on this date. Format YYYY-MM-DD, read as whole days in the provider's timezone rather than UTC.
Example:2025-09-20
filter[updated_at:equals]string
An alias of filter[updated_at:on].
Example:2025-09-20
filter[updated_at:after]string
Only return information items last updated after this date. Format YYYY-MM-DD, read as whole days in the provider's timezone rather than UTC.
Example:2024-09-20
filter[updated_at:between]string
Only return information items last updated between two dates, inclusive. Comma-separate the start and end dates. Format YYYY-MM-DD, read as whole days in the provider's timezone rather than UTC.
Example:2024-09-20,2025-09-20
sortstring
Sort the results. Prefix with '-' for descending. One of: created_at, updated_at.
Example:updated_at
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 ParticipantInformationItemResource

dataobject[]required
▶Show 6 child attributesHide child attributes
- idstringrequired
  Example:i1n2f3o4-a5b6-47c8-9d0e-1f2a3b4c5d6e
- detailstring | nullrequired
  Example:Medication details for participant
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00
- updated_atstring | nullrequired
  Example:2024-06-02T09:15:00+00:00
- info_itemobject | nullrequired
  ▶Show 5 child attributesHide child attributes
  idstringrequired
  Example:i1t2e3m4-d5e6-47f8-9a0b-1c2d3e4f5a6b
  namestringrequired
  Example:Emergency Contact
  requiredbooleanrequired
  Example:true
  documents_allowedbooleanrequired
  Example:true
  visible_to_support_workersbooleanrequired
  Example:false
- documentsobject[] | string[]required
  ▶Show 5 child attributesHide child attributes
  idstringrequired
  Example:d1c2e3f4-a5b6-47c8-9d0e-1f2a3b4c5d6e
  namestringrequired
  Example:Service Agreement
  file_extensionstringrequired
  Example:pdf
  created_atstringrequired
  Example:2024-01-15T10:30:00+00:00
  categoriesobject[]required
  ▶Show 2 child attributesHide child attributes
  idstringrequired
  Example:c4a5b6c7-d8e9-40f1-a2b3-c4d5e6f7a8b9
  namestringrequired
  Example:Assessments
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