ALallquiet
IncidentResourceSearch

Get an incident by ID

Returns a single incident the caller is authorized to view. Returns 404 when the incident does not exist or is outside the key's allowed teams. Voicemail download attributes include voiceMail.downloadUrl (retrieve the audio with this API key) and voiceMail.privateDownloadUrl (signed-in web app). Send If-None-Match with the ETag from a previous response to receive 304 Not Modified when the incident has not changed.

Required API key permissions

  • Scope: incidents:get
  • Accepted key types: organization API key (org-wide), organization API key (team-scoped), personal access token (org-wide), personal access token (team-scoped)
  • Access: Access is checked against the specific resource (team or organization reachability).
get/api/public/v1/incident/search/{incidentId}

Request

Path parameters

incidentIdstring uuid required

Headers

If-None-Matchstring

Weak ETag from a previous response. When it still matches, the server returns 304 Not Modified with an empty body.

If-Modified-Sincestring

HTTP-date from a previous Last-Modified header. Used only when If-None-Match is not sent.

Response

OK

idstring uuid required
titlestring nullable required
createdAtstring date-time nullable required
lastUpdatedAtstring date-time required
eventsTotalCountinteger required
unattendedboolean required
isArchivedboolean required
allowedIntentsstring[] nullable required
canDeleteboolean nullable
excludeFromUptimeCalculationboolean
statusPageStartOverridestring date-time nullable
statusPageEndOverridestring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.