ticket_notes

List /ticket_notes

List internal staff notes of tickets (the CRM ticket Notes tab; never shown to clients). Use filter[ticket] for one ticket or filter[created_since] to poll new notes across tickets. Mandatory status-change comments are stored as notes too. A note is visible when its ticket is. Response: items and pagination.

GET

/ticket_notes

List /ticket_notes

curl --request GET \
  --url 'https://default.hannacrm.app/api/v4/ticket_notes?query=%3Cstring%3E&page=123&per_page=123&filter%5Bticket%5D=%3Cstring%3E&filter%5Bcreated_since%5D=2023-11-07T05%3A31%3A56Z&filter%5Bcreated_at%5D=%3Cstring%3E&filter%5Bcreated_by%5D=3c90c3cc-0d44-4b50-8888-8dd25736052a&filter%5Buuid%5D=%3Cstring%3E&sort=%3Cstring%3E&fields=%3Cstring%3E' \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": {
        "name": "<string>",
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "description": "<string>",
      "ticket": {
        "subject": "<string>",
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "uuid": "<string>"
    }
  ],
  "pagination": {
    "from": 123,
    "last_page": 123,
    "page": 123,
    "per_page": 123,
    "to": 123,
    "total": 123
  },
  "query": "<string>"
}

Authorizations

Authorizationstringheaderrequired

API key (Bearer token) created in Setup → API & MCP.

Query Parameters

querystringquery

Optional search phrase matched against the note text.

Minimum string length: 1

pageintegerquery

Page number (1-based).

Required range: 1 <= x

per_pageintegerquery

Number of results per page.

Required range: 1 <= x <= 50

filter[ticket]stringquery

Ticket UUIDs: the notes of these tickets.

filter[created_since]stringquery

Return only notes added at or after this ISO 8601 timestamp (e.g. 2026-09-01T00:00:00Z). Intended for polling new notes across all tickets.

filter[created_at]stringquery

Note date range (YYYY-MM-DD - YYYY-MM-DD).

filter[created_by]string[]query

Author staff UUIDs.

filter[uuid]stringquery

Note UUIDs. Use it to fetch several known notes in one call.

sortstringquery

Optional sort order, comma-separated; prefix a field with - for descending (e.g. sort=-updated_at); empty values sort last. Sortable fields: created_at, description, uuid. Default when omitted: -dateadded,-id.

fieldsstring[]query

Optional response field paths (dot notation for nested groups, e.g. billing_address.street; array fields are returned whole). Comma-separated string is also accepted. Identifier field is always included.

Response

Search results

itemsobject[]

Show child attributes

paginationobject

Show child attributes

querystring

Still need help? Ask the team