> ## Documentation Index > Fetch the complete documentation index at: https://docs.go.aiinsurance.io/llms.txt > Use this file to discover all available pages before exploring further. # List Notes > Returns a paginated list of notes for a parent entity, newest first by the note's display date (`displayDate` when set, else `createdAt`) — so backdated historical notes interleave correctly. The parent entity is selected by the `entityType` (lowercase kebab-case) and `entityId` query parameters. Pagination is 1-based via `page`/`pageSize`. Pass `search` to filter to notes whose body contains a substring (case-insensitive). **Required permission:** `company.note:read`. ## OpenAPI ````yaml /openapi/generated-external-api.yaml get /api/v1/companies/{companyId}/notes openapi: 3.0.3 info: title: AI Insurance External API description: External API for AI Insurance platform version: 1.0.0 contact: email: support@aiinsurance.io servers: - url: https://go.aiinsurance.io description: Production security: - ApiKeyAuth: [] paths: /api/v1/companies/{companyId}/notes: get: tags: - Field Model Notes summary: List Notes description: > Returns a paginated list of notes for a parent entity, newest first by the note's display date (`displayDate` when set, else `createdAt`) — so backdated historical notes interleave correctly. The parent entity is selected by the `entityType` (lowercase kebab-case) and `entityId` query parameters. Pagination is 1-based via `page`/`pageSize`. Pass `search` to filter to notes whose body contains a substring (case-insensitive). **Required permission:** `company.note:read`. operationId: listNotes parameters: - $ref: '#/components/parameters/companyId' - $ref: '#/components/parameters/noteEntityType' - $ref: '#/components/parameters/noteParentEntityId' - $ref: '#/components/parameters/noteSearch' - $ref: '#/components/parameters/page' - name: pageSize in: query schema: type: integer minimum: 1 default: 50 description: Number of records per page (default 50). responses: '200': description: Paginated list of notes content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/FieldModelV1Note' totalCount: type: integer description: Total number of matching notes across all pages examples: success: summary: Notes for an event value: items: - id: 550e8400-e29b-41d4-a716-446655440020 entityType: event entityId: 550e8400-e29b-41d4-a716-446655440200 note: Adjuster called the insured for clarification. displayDate: null createdAt: '2026-01-15T10:30:00.000Z' createdBy: 550e8400-e29b-41d4-a716-446655440999 createdByName: Jane Adjuster updatedAt: '2026-01-15T10:30:00.000Z' updatedBy: 550e8400-e29b-41d4-a716-446655440999 totalCount: 1 empty: summary: No notes found value: items: [] totalCount: 0 '400': description: Bad Request - Invalid or missing entityType / entityId content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: invalidEntityType: summary: Invalid entityType value: error: code: INVALID_ENTITY_TYPE message: Invalid entityType. Must be a configured entity. '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '500': $ref: '#/components/responses/InternalServerError' components: parameters: companyId: name: companyId in: path required: true schema: type: string format: uuid description: Company identifier noteEntityType: name: entityType in: query required: true schema: type: string enum: - event - exposure - quote - submission - person - organization - policy description: > Parent entity type (lowercase kebab-case URL slug), e.g. `event`, `exposure`, `policy`. Selects the per-entity permission enforced for the request and scopes the note to its parent entity. PascalCase (`Event`) is rejected with a 400 — matching the `/entities/{type}` path convention. noteParentEntityId: name: entityId in: query required: true schema: type: string format: uuid description: Parent entity identifier whose notes are being listed noteSearch: name: search in: query required: false schema: type: string description: > Optional case-insensitive substring filter. When provided, only notes whose body contains this text are returned (matches anywhere in the note). page: name: page in: query schema: type: integer minimum: 1 default: 1 description: Page number (1-based, default 1). schemas: FieldModelV1Note: type: object description: > A note attached to a top-level Field Model V1 entity. Notes are simple text records scoped to a parent entity (identified by `entityType` + `entityId`). `createdByName` is resolved from the users table for display. required: - id - entityType - entityId - note - createdAt - updatedAt properties: id: type: string format: uuid description: Note identifier entityType: type: string enum: - event - exposure - quote - submission - person - organization - policy description: The parent entity type (lowercase kebab-case) entityId: type: string format: uuid description: The parent entity identifier note: type: string description: The note body displayDate: type: string format: date-time nullable: true description: >- Optional back-datable "as of" date. When set, lists display and sort the note by this date instead of `createdAt` — intended for historical imports and integrations. The audit timestamps (`createdAt`/`updatedAt`) always reflect actual system changes and cannot be overridden. displayAuthor: type: string nullable: true description: >- Optional user-visible author label. When set, the note is displayed as authored by this label instead of `createdByName` — intended for historical imports carrying the source system's author (or a marker like "Data Import"). The audit attribution (`createdBy`) always reflects the real acting principal and cannot be overridden. createdAt: type: string format: date-time description: When the note was created createdBy: type: string nullable: true description: User ID who created the note createdByName: type: string nullable: true description: Display name of the creating user, resolved for display only updatedAt: type: string format: date-time description: When the note was last updated updatedBy: type: string nullable: true description: User ID who last updated the note ErrorResponse: type: object description: Standard error response for all external API endpoints required: - error properties: error: type: object required: - code - message properties: code: type: string description: Machine-readable error code example: VALIDATION_ERROR message: type: string description: Human-readable error message example: 'submissionId: Required field is missing' userMessages: type: array description: >- Clean, verbatim-displayable messages — one entry per failure, free of error-code tags, field paths, and internal noise. Suitable for showing to end users as-is. items: type: string example: - Exposures of type 'company' require an address details: type: array description: Additional details for validation errors (field-level errors) items: type: object properties: field: type: string description: The field that caused the error example: submissionId message: type: string description: Description of the field error example: Required field is missing responses: Unauthorized: description: Unauthorized - Invalid or missing API key content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: missingApiKey: summary: Missing API key value: error: code: AuthenticationError message: API key authentication required userMessages: - API key authentication required invalidApiKey: summary: >- Invalid API key (e.g. unknown key, or a Bearer token used instead of an API key) value: error: code: AuthenticationError message: Invalid API key userMessages: - Invalid API key Forbidden: description: Forbidden - Insufficient permissions content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: insufficientPermissions: summary: Insufficient permissions value: error: code: AuthorizationError message: User is not authorized to perform the requested action userMessages: - User is not authorized to perform the requested action companyMismatch: summary: A valid API key naming another company in the URL value: error: code: AuthorizationError message: API key is not scoped to the requested company userMessages: - API key is not scoped to the requested company InternalServerError: description: Internal Server Error - Unexpected error occurred content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: internalError: summary: Unexpected server error value: error: code: UncaughtActionError message: Uncaught error occurred in userMessages: - An unexpected error occurred. Please try again later. securitySchemes: ApiKeyAuth: type: apiKey in: header name: Authorization description: >- API key authentication. Send your raw API key as the `Authorization` header value with NO scheme prefix — `Authorization: YOUR-API-KEY`. Do NOT prefix it with `Bearer ` or `ApiKey `, and do not use an `X-API-Key` header; those are not accepted. ````