get
https://hub.xyte.io/core/v1/organization/incidents//notes
Retrieve the notes attached to an incident.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
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
| Parameter | Type | Description |
|---|---|---|
| incident_id | string | Unique identifier of the incident (UUID). |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| page | integer | Page number, starting at 1. Default 1. |
| per_page | integer | Results per page. Default 20, max 500. |
Response
{ "items": [...], "has_next_page": <bool> }. Each note:
| Key | Type | Description |
|---|---|---|
| id | string | Unique identifier of the note (UUID). |
| content | string | Note content (Markdown). |
| notable_type | string | Always Incident. |
| notable_id | string | The incident the note is attached to. |
| created_by | string | null | The user who wrote the note, in the portal or with an OAuth2 token; null for notes written with an API key. |
| author | string | null | The 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_id | string | null | The API key that wrote the note; null for notes written in the portal, with an OAuth2 token, or by an integration. |
| created_at | string | ISO 8601. |
| updated_at | string | ISO 8601. |
Errors
| Status | Description |
|---|---|
| 401 | The API key or token is missing or invalid. |
| 404 | The incident does not exist or does not belong to your organization. |
