IncidentsIncident options

Incident options

Needs: Incidents, Read

Returns the statuses, priorities and categories, the incident custom attributes, and the staff who can be assigned or set as reporter. Use it before creating or editing incidents.

Note: Each custom attribute has a key, label and input_type, plus options and required when they apply. on_create_form shows whether it is on the report form. Custom attributes and staff depend on your organisation.

curl -X GET "https://app.imploy.com.au/api/integrations/v1/incidents/options" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "statuses": [
    "Triage",
    "Open",
    "Resolving",
    "On Hold",
    "Resolved",
    "Not an Incident",
    "Archived"
  ],
  "priorities": [
    "Low",
    "Medium",
    "High"
  ],
  "categories": [
    "Medication",
    "Behaviour",
    "Injury",
    "Abuse",
    "Restrictive",
    "Privacy",
    "Other"
  ],
  "custom_attributes": [
    {
      "key": "witnessed",
      "label": "Witnessed",
      "input_type": "text",
      "on_create_form": true
    }
  ],
  "staff": [
    {
      "id": 31,
      "name": "Example Worker"
    }
  ]
}
GET
/incidents/options
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.

An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.

Responses

OK