Skip to main content
GET
Listar notas
Returns a paginated list of notes. Results cover the whole company, not just the project your token belongs to — see Tenancy is implicit. The usual pattern is to filter by ticket_id to build a ticket’s activity timeline, or by chat_user to build a contact’s.

Endpoint

Required scope

crm:notes:read

Headers

Query parameters

Example request

Response

200 OK

400 Bad Request

A chat_user or ticket_id that is not a valid ObjectId, a type outside the allowed set, limit above 200, or an unknown query parameter.

401 Unauthorized

Missing, invalid, revoked, or expired token.

403 Forbidden

The token does not have the crm:notes:read scope.

Operational notes

  • created_by is a user id, not the note author’s name. There is no public endpoint for resolving users to names yet — cache the mapping from the portal if you need to display it.

Authorizations

Authorization
string
header
required

Personal Access Token con prefijo kbai_pk_. Generar desde el portal con permiso developer.manage_tokens.

Query Parameters

chat_user
string

Filtrar por chat user (contacto)

ticket_id
string

Filtrar por ticket

type
enum<string>
Available options:
note,
call,
email,
meeting
limit
number
default:50
Required range: 1 <= x <= 200
offset
number
default:0
Required range: x >= 0

Response

200 - application/json
data
object[]
required
total
number
required
limit
number
required
offset
number
required