ConversationNoteListResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/elocuenti-com/json-schema/elocuenti-com-conversation-note-list-response-schema.json",
  "title": "ConversationNoteListResponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/elocuenti-com-conversations-api-openapi.yml#/components/schemas/ConversationNoteListResponse",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ConversationNote"
      },
      "title": "Data"
    },
    "request_id": {
      "type": "string",
      "description": "The identifier of this request. Give it to support if you need help.",
      "title": "Request Id"
    },
    "next_cursor": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Send it as `cursor` to get the next page. `null` on the last page. It is opaque: do not build or parse it.",
      "title": "Next Cursor"
    }
  },
  "required": [
    "data",
    "request_id",
    "next_cursor"
  ],
  "$defs": {
    "ConversationNote": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The identifier of the note.",
          "title": "Id"
        },
        "conversation_id": {
          "type": "string",
          "description": "The identifier of the conversation the note belongs to.",
          "title": "Conversation Id"
        },
        "body": {
          "type": "string",
          "description": "The text of the note, up to 5000 characters.",
          "title": "Body"
        },
        "author": {
          "$ref": "#/$defs/NoteAuthor"
        },
        "created_at": {
          "type": "string",
          "description": "When the note was written (UTC, ISO 8601).",
          "title": "Created At"
        },
        "updated_at": {
          "type": "string",
          "description": "The last time its text changed (UTC, ISO 8601). The same as `created_at` if it never changed.",
          "title": "Updated At"
        }
      },
      "required": [
        "id",
        "conversation_id",
        "body",
        "author",
        "created_at",
        "updated_at"
      ],
      "description": "An internal note of a conversation. Only your team sees it: it is never sent to the customer.",
      "title": "ConversationNote"
    },
    "NoteAuthor": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "user",
            "api_key"
          ],
          "description": "`user`: a person of your team wrote it in the dashboard or the app. `api_key`: it was written through the API with that key.",
          "title": "Type"
        },
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "The identifier of the person (see `GET /api/v1/agents`) or of the API key. `null` when the person is no longer in your team.",
          "title": "Id"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "description": "The name of the person as the dashboard shows it, or the name you gave the API key. `null` when the person is no longer in your team.",
          "title": "Name"
        }
      },
      "required": [
        "type",
        "id",
        "name"
      ],
      "description": "Who wrote a note.",
      "title": "NoteAuthor"
    }
  }
}