Incidents

List incident responders

List all responders for an incident.

get/api/v2/incidents/{incident_id}/responders

Request

Path parameters

incident_idstring required

The UUID of the incident.

Query parameters

includeIncidentResponderRelatedObject[]

Comma-separated related resource types to include. Supported values are users and role_assignments.

[
  "users",
  "role_assignments"
]
page[limit]integer
Example:25

Maximum number of responders to return per page.

page[offset]integer

The offset of the first responder to return.

Response

OK

linksobject

Links to pages of incident responders.

Example response

{
  "data": [
    {
      "attributes": {
        "created": "2024-01-01T00:00:00.000Z",
        "is_billable": true,
        "last_active": "2024-01-01T00:00:00.000Z",
        "modified": "2024-01-01T00:00:00.000Z"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "relationships": {
        "created_by": {
          "data": {
            "id": "00000000-0000-0000-2345-000000000000",
            "type": "users"
          }
        },
        "last_modified_by": {
          "data": {
            "id": "00000000-0000-0000-2345-000000000000",
            "type": "users"
          }
        },
        "role_assignments": {
          "data": [
            {
              "id": "00000000-0000-0000-0000-000000000000",
              "type": "incident_role_assignments"
            }
          ]
        },
        "user": {
          "data": {
            "id": "00000000-0000-0000-0000-000000000000",
            "type": "users"
          }
        }
      },
      "type": "incident_responders"
    }
  ],
  "included": [
    {
      "type": "users"
    }
  ],
  "meta": {
    "page": {
      "total_filtered_count": 1
    },
    "pagination": {
      "last_offset": 25,
      "limit": 25,
      "next_offset": 25,
      "total": 1,
      "type": "offset_limit"
    }
  }
}

Changes

Changes to this operation have not been checked yet.