> ## Documentation Index > Fetch the complete documentation index at: https://docs.corbado.com/llms.txt > Use this file to discover all available pages before exploring further. # List annotations > Lists Observe annotations, optionally filtered to a time window by dateMs. Paginated; sorted by createdMs (default descending). Required API key permission: `observe:annotations:read`. ## OpenAPI ````yaml /api-reference/openapi/observe.yaml get /observe/annotations openapi: 3.1.1 info: version: 1.0.0 title: Corbado API description: > # Introduction This documentation gives an overview of all Corbado API calls to implement authentication observe. contact: name: Corbado team email: support@corbado.com url: https://www.corbado.com servers: - url: https://api.cloud.corbado.io/v1 security: - bearerAuth: [] tags: - name: ObserveFlow description: Flow search and related APIs x-group: Journeys and users - name: ObserveSubFlow description: Subflow search and related APIs x-group: Journeys and users - name: ObserveUser description: User search and related APIs x-group: Journeys and users - name: ObserveClientEnv description: Client environment search APIs x-group: Journeys and users - name: ObserveTimeSeries description: Time series query APIs x-group: Metrics and funnels - name: ObserveFunnel description: Historical funnel metrics, dictionaries and coverage. x-group: Metrics and funnels - name: ObserveEvent description: Event ingestion and event feed APIs x-group: Events - name: ObserveError description: Named authentication errors and recommendations. x-group: Error management - name: ObserveErrorFlavour description: Error variants and their impact on authentication outcomes. x-group: Error management - name: ObserveAlert description: Authentication alert rules, instances and history. x-group: Alert management - name: ObserveAnnotation description: Annotation APIs (dated notes for analytics context) x-group: Annotations - name: ObserveTableExport description: Table export file listing and download APIs x-group: Data exports - name: ObserveTimeSeriesExport description: Time-series export generation and downloads. x-group: Data exports - name: ObserveDataExport description: Data export APIs x-group: User data - name: ObserveDataDeletionJob description: Data deletion job APIs x-group: User data - name: ObserveFlowTypeDefinition description: Flow type definitions used in authentication journeys. x-group: Catalogs and labels - name: ObserveCatalog description: Catalog APIs x-group: Catalogs and labels - name: OpenAPI description: Downloadable API specification - name: ProjectOperationExecution description: Project-scoped operation history and pipeline health - name: ObserveClassification description: Flow and subflow classification APIs - name: ObserveIntegrationStats description: Integration stats APIs - name: ObserveTimeSeriesPrecalculation description: Time series precalculation APIs - name: ObserveIDList x-group: Saved ID lists description: Stored ID-list selection APIs - name: ObserveDataContext description: Schema-loose data context APIs for agent and debugging tooling - name: ObserveData description: Observe data administration APIs - name: ObserveTrackingStats description: Tracking ingestion stats APIs - name: ObserveExperiment x-group: Experiments description: Experiment catalog and run APIs - name: ObserveDataPolicy description: >- Project data policy catalogue (retention selected by the SDK's meta.dataPolicy code) - name: ObserveMetadata x-group: Metadata description: Authenticator metadata APIs (FIDO MDS + passkey AAGUID) - name: ObservePasskey x-group: Passkey analysis description: Observed passkey search and cohort analysis. paths: /observe/annotations: get: tags: - ObserveAnnotation summary: List annotations description: >- Lists Observe annotations, optionally filtered to a time window by dateMs. Paginated; sorted by createdMs (default descending). Required API key permission: `observe:annotations:read`. operationId: ObserveAnnotationList parameters: - name: fromMs in: query required: false description: >- Only return annotations with dateMs greater than or equal to this value (epoch ms). schema: type: integer format: int64 x-oapi-codegen-extra-tags: validate: omitempty,min=0 - name: toMs in: query required: false description: >- Only return annotations with dateMs less than or equal to this value (epoch ms). schema: type: integer format: int64 x-oapi-codegen-extra-tags: validate: omitempty,min=0 - name: orderBy in: query required: false description: Field to order by schema: type: string default: created enum: - created - date x-oapi-codegen-extra-tags: validate: omitempty,oneof=created date - name: orderDirection in: query required: false description: Order direction schema: type: string default: desc enum: - asc - desc x-oapi-codegen-extra-tags: validate: omitempty,oneof=asc desc - name: page in: query description: | The page number to retrieve for paginated results. required: false schema: type: integer default: 1 example: 1 - name: pageSize in: query description: | The number of items to return per page. Useful for pagination. required: false schema: type: integer default: 10 example: 20 responses: '200': description: >- Paginated list of annotations. Paging metadata is returned in X-Corbado-Page, X-Corbado-TotalPages, and X-Corbado-TotalItems response headers. content: application/json: schema: type: array maxItems: 1000 items: $ref: '#/components/schemas/observeAnnotation' default: $ref: '#/components/responses/error' security: - bearerAuth: - observe:annotations:read components: schemas: observeAnnotation: type: object required: - id - headline - dateMs - createdMs - updatedMs properties: id: type: string description: Annotation ID (format `ann-`). headline: type: string description: Short headline describing the annotation. description: type: string description: Optional longer description of the annotation. dateMs: description: The annotated point in time in milliseconds since epoch. type: integer format: int64 createdMs: type: integer format: int64 description: Creation time in milliseconds since epoch. updatedMs: type: integer format: int64 description: Last update time in milliseconds since epoch. errorRspV2: type: object required: - error properties: error: type: object required: - message properties: message: description: Error message type: string example: Validation failed details: description: Validation error details per field type: array items: type: object required: - field - message properties: field: description: Field name that failed validation type: string example: projectID message: description: Validation error message type: string example: required responses: error: description: Error content: application/json: schema: $ref: '#/components/schemas/errorRspV2' securitySchemes: bearerAuth: type: http scheme: bearer description: >- Use an Observe API key from the management console. The key selects the project and must grant the permission listed on the operation. Keep this key on your server. ````