inbox.notes_list
Listar notas internas. Notas e respostas da conta em ordem crescente de hora (as mais recentes quando passa de limit, padrão 100). Filtros: conversationId, q (texto), userId (autor), from/to (data ISO). Traz autor, quantidade de respostas e se foi editada ou removida.
- Endpoint:
POST https://app.atomiks.com.br/api/v1/inbox.notes_list(corpo JSON) - Quem pode chamar: membro da conta
- Escopo da chave:
messages:read - Grava dados: não
- Pela chave de API: sim
- Ferramenta MCP:
inbox_notes_list - Ficha em JSON:
https://app.atomiks.com.br/api/v1/openapi.json(operationIdinbox.notes_list)
Entrada
| Campo | Tipo | Obrigatório | Nota |
|---|---|---|---|
conversationId | string (uuid) | não | |
q | string | não | |
userId | string (uuid) | não | |
from | string (date-time) | não | |
to | string (date-time) | não | |
limit | integer | não |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"conversationId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"q": {
"type": "string",
"maxLength": 80
},
"userId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"from": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"to": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 200
}
}
}Exemplo
curl -X POST https://app.atomiks.com.br/api/v1/inbox.notes_list \
-H "Authorization: Bearer $ATOMIKS_API_KEY" \
-H "Content-Type: application/json" \
-d '{"conversationId":"00000000-0000-0000-0000-000000000000"}'CLI:
node cli/atomiks.mjs inbox.notes_list --json '{"conversationId":"00000000-0000-0000-0000-000000000000"}'MCP: ferramenta inbox_notes_list com a mesma entrada.
Saída
Sucesso: {"data": ...} com o formato abaixo.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"conversationId": {
"type": "string"
},
"parentNoteId": {
"type": [
"string",
"null"
]
},
"body": {
"type": [
"string",
"null"
]
},
"author": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string"
},
"edited": {
"type": "boolean"
},
"deleted": {
"type": "boolean"
},
"repliesCount": {
"type": "number"
}
},
"required": [
"id",
"conversationId",
"parentNoteId",
"body",
"author",
"createdAt",
"edited",
"deleted",
"repliesCount"
],
"additionalProperties": false
}
}
},
"required": [
"items"
],
"additionalProperties": false
}Erros
{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).