Get Incident Notes

Retrieve the notes attached to an incident.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This endpoint returns the notes attached to an incident, newest first. It sends an HTTP GET request to https://hub.xyte.io/core/v1/organization/incidents/{incident_id}/notes.

Authorization

This endpoint requires Authorization.

Path Parameters

ParameterTypeDescription
incident_idstringUnique identifier of the incident (UUID).

Query Parameters

ParameterTypeDescription
pageintegerPage number, starting at 1. Default 1.
per_pageintegerResults per page. Default 20, max 500.

Response

{ "items": [...], "has_next_page": <bool> }. Each note:

KeyTypeDescription
idstringUnique identifier of the note (UUID).
contentstringNote content (Markdown).
notable_typestringAlways Incident.
notable_idstringThe incident the note is attached to.
created_bystring | nullThe user who wrote the note, in the portal or with an OAuth2 token; null for notes written with an API key.
authorstring | nullThe user's name, or API · <key name> for a note written with an API key (API when the key has no name or is an integration's key). null if the user or API key that wrote it was deleted.
api_key_idstring | nullThe API key that wrote the note; null for notes written in the portal, with an OAuth2 token, or by an integration.
created_atstringISO 8601.
updated_atstringISO 8601.

Errors

StatusDescription
401The API key or token is missing or invalid.
404The incident does not exist or does not belong to your organization.
Path Params
string
required

Unique identifier of the incident (UUID).

Query Params
integer
Defaults to 1

Page number, starting at 1.

integer
Defaults to 20

Number of results per page. Min: 1, Max: 500.

Response

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json