List Risks for a Participant

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

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

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

Response

{
  "data": [
    {
      "id": "r1i2s3k4-d5e6-47f8-9a0b-1c2d3e4f5a6b",
      "title": "Falls risk during transfers",
      "description": "Participant has a history of falls",
      "likelihood": "possible",
      "consequence": "moderate",
      "residual_likelihood": "unlikely",
      "inherent_risk": {
        "score": 12,
        "level": "high"
      },
      "residual_risk": {
        "score": 12,
        "level": "high"
      },
      "risk_to": "participant",
      "status": "active",
      "risk_management_type": "treat",
      "review_frequency": "quarterly",
      "visible_to_support_workers": false,
      "last_reviewed_at": "2024-01-15T10:30:00+00:00",
      "next_review_at": "2024-04-15T10:30:00+00:00",
      "archived_at": "2024-01-15T10:30:00+00:00",
      "created_at": "2024-01-15T10:30:00+00:00",
      "controls": [
        {
          "id": "c1o2n3t4-r5o6-47l8-9a0b-1c2d3e4f5a6b",
          "title": "Use transfer belt",
          "description": "Always use a transfer belt when assisting",
          "created_at": "2024-01-15T10:30: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

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 ParticipantRiskResource

dataobject[]required
▶Show 18 child attributesHide child attributes
- idstringrequired
  Example:r1i2s3k4-d5e6-47f8-9a0b-1c2d3e4f5a6b
- titlestringrequired
  Example:Falls risk during transfers
- descriptionstring | nullrequired
  Example:Participant has a history of falls
- likelihoodintegerrequired
  Example:possible
- consequenceintegerrequired
  Example:moderate
- residual_likelihoodintegerrequired
  Example:unlikely
- inherent_riskobjectrequired
  ▶Show 2 child attributesHide child attributes
  scoreintegerrequired
  Example:12
  levelenum<string>required
  Available options:catastrophichighlowmoderate
- residual_riskobjectrequired
  ▶Show 2 child attributesHide child attributes
  scoreintegerrequired
  Example:12
  levelenum<string>required
  Available options:catastrophichighlowmoderate
- risk_tostringrequired
  Example:participant
- statusstringrequired
  Example:active
- risk_management_typestringrequired
  Example:treat
- review_frequencystringrequired
  Example:quarterly
- visible_to_support_workersbooleanrequired
  Example:false
- last_reviewed_atstring | nullrequired
  Example:2024-01-15T10:30:00+00:00
- next_review_atstringrequired
  Example:2024-04-15T10:30:00+00:00
- archived_atstring | nullrequired
  Example:2024-01-15T10:30:00+00:00
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00
- controlsobject[]required
  ▶Show 4 child attributesHide child attributes
  idstringrequired
  Example:c1o2n3t4-r5o6-47l8-9a0b-1c2d3e4f5a6b
  titlestringrequired
  Example:Use transfer belt
  descriptionstring | nullrequired
  Example:Always use a transfer belt when assisting
  created_atstringrequired
  Example:2024-01-15T10:30: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