Get an Incident

get/public/v1/incidents/{incident}

get/public/v1/incidents/{incident}

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

Response

{
  "data": {
    "id": "i1n2c3i4-d5e6-47n8-9t0a-1b2c3d4e5f6g",
    "reference": "INC-2024-00456",
    "type": "participant",
    "time": "2024-01-15T10:30:00+00:00",
    "reportable": "no",
    "reportable_type": "restrictive_practice",
    "details": "Something happened during a session",
    "follow_up_details": "Follow up actions were taken",
    "status": "reported",
    "severity": "low",
    "completed_at": "2024-02-01T09:00:00+00:00",
    "form_submission": {
      "id": "f5a6b7c8-d9e0-41f2-a3b4-c5d6e7f8a9b0"
    },
    "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

incidentstringrequired
The incident UUID

Response

200application/json

IncidentResource

dataobjectrequired
▶Show 13 child attributesHide child attributes
- idstringrequired
  Example:i1n2c3i4-d5e6-47n8-9t0a-1b2c3d4e5f6g
- referencestringrequired
  Example:INC-2024-00456
- typestringrequired
  Example:participant
- timestringrequired
  Example:2024-01-15T10:30:00+00:00
- reportablestringrequired
  Example:no
- reportable_typestring | nullrequired
  Example:restrictive_practice
- detailsstringrequired
  Example:Something happened during a session
- follow_up_detailsstring | nullrequired
  Example:Follow up actions were taken
- statusstringrequired
  Example:reported
- severitystring | nullrequired
  Example:low
- completed_atstring | nullrequired
  Example:2024-02-01T09:00:00+00:00
- form_submissionobject | nullrequired
  ▶Show 1 child attributesHide child attributes
  idstringrequired
  Example:f5a6b7c8-d9e0-41f2-a3b4-c5d6e7f8a9b0
- created_atstringrequired
  Example:2024-01-15T10:30:00+00:00

Errors

401Unauthenticated
403Authorization error
404Not found

Command Palette

Authorization

Path parameters

Response

Errors