> ## 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 the project's annotations together with platform annotations, which apply to every project. Paginated; sorted by `createdMs` (default descending). Filter by `kind` (repeat the parameter for several kinds); without it all kinds are returned. `fromDate` and `toDate` select a window in project time. A period is returned when it overlaps the window, an event when its date lies inside it. Annotations without a date and follow-ups (whose date says when they become ready) are always returned. 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: ObserveIdentifier description: Identifier search over submitted identifiers 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: ObserveFinding description: Curated findings that explain errors, their impact and who has to act. x-group: Error management - name: ObserveAlert description: Authentication alert rules, instances and history. x-group: Alert management - name: ObserveAnnotation description: >- Annotations, the project's memory (what is true about the data and how to read it) 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: ObserveProbe description: Raw probe capture items (internal autocapture diagnostics) - name: ObserveTelemetry description: Raw SDK/integration diagnostic telemetry - 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 the project's annotations together with platform annotations, which apply to every project. Paginated; sorted by `createdMs` (default descending). Filter by `kind` (repeat the parameter for several kinds); without it all kinds are returned. `fromDate` and `toDate` select a window in project time. A period is returned when it overlaps the window, an event when its date lies inside it. Annotations without a date and follow-ups (whose date says when they become ready) are always returned. Required API key permission: `observe:annotations:read`. operationId: ObserveAnnotationList parameters: - name: kind in: query required: false description: Kinds to return. Without it, all kinds are returned. style: form explode: true schema: type: array maxItems: 6 items: $ref: '#/components/schemas/observeAnnotationKind' x-oapi-codegen-extra-tags: validate: >- omitempty,max=6,dive,oneof=event period setup interpretation constraint follow-up - name: fromDate in: query required: false description: >- Window start (inclusive) as a local datetime in project time, formatted as YYYY-MM-DDTHH:MM:SS. schema: type: string pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ example: '2026-09-01T00:00:00' x-oapi-codegen-extra-tags: validate: omitempty,datetime=2006-01-02T15:04:05 - name: toDate in: query required: false description: >- Window end (exclusive) as a local datetime in project time, formatted as YYYY-MM-DDTHH:MM:SS. schema: type: string pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ example: '2026-10-01T00:00:00' x-oapi-codegen-extra-tags: validate: omitempty,datetime=2006-01-02T15:04:05 - name: orderBy in: query required: false description: Field to order by; `date` orders by the start date. 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: observeAnnotationKind: type: string enum: - event - period - setup - interpretation - constraint - follow-up description: >- What the annotation records: `event` something changed, `period` something held over a span, `setup` a fact about how the project works, `interpretation` how to read the data, `constraint` which data may be used, `follow-up` an unknown or open work. observeAnnotation: type: object required: - id - kind - platform - headline - approximate - display - source - createdMs - updatedMs properties: id: type: string description: Annotation ID (format `ann-`). kind: $ref: '#/components/schemas/observeAnnotationKind' platform: type: boolean description: >- Platform annotation that applies to every project; managed by Corbado. headline: type: string description: One line saying what the annotation records. description: type: string description: Optional Markdown body with details. dateFrom: type: string description: >- Date as stated, in project time (UTC for platform annotations), in the format of its precision. dateTo: type: string description: >- Last unit a period covers (inclusive), in the same format. Absent on an ongoing period. datePrecision: $ref: '#/components/schemas/observeAnnotationDatePrecision' dateFromMs: type: integer format: int64 description: Start of `dateFrom` in milliseconds since epoch. dateToMs: type: integer format: int64 description: End of the span (exclusive) in milliseconds since epoch. approximate: type: boolean description: The date is not exact. status: $ref: '#/components/schemas/observeAnnotationStatus' effect: $ref: '#/components/schemas/observeAnnotationEffect' reading: type: string description: Reading rule this date brings (events and periods). scope: $ref: '#/components/schemas/observeAnnotationScope' series: type: array maxItems: 50 items: type: string display: type: boolean description: Shown on charts. source: $ref: '#/components/schemas/observeAnnotationSource' evidence: type: array maxItems: 4 items: $ref: '#/components/schemas/observeAnnotationEvidence' refs: type: array maxItems: 50 items: $ref: '#/components/schemas/observeAnnotationRef' externalKey: type: string 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. observeAnnotationDatePrecision: type: string enum: - month - date - hour - datetime description: Unit the annotation's dates were stated in. observeAnnotationStatus: type: string enum: - open - done description: Where a follow-up stands. observeAnnotationEffect: type: string enum: - context - boundary - degraded - broken - missing description: >- How an event or period changes the reading of the data: `context` background only, `boundary` compare only within one side, `degraded` data partly wrong, `broken` data wrong, `missing` no data. observeAnnotationScope: type: object description: >- Narrows what the annotation applies to, by time-series dimension. Absent means the whole project. additionalProperties: false properties: applicationID: type: string description: Application ID (format `app-`). x-oapi-codegen-extra-tags: validate: omitempty,id=app os: type: string x-oapi-codegen-extra-tags: validate: omitempty,min=1,max=255 osVersion: type: string x-oapi-codegen-extra-tags: validate: omitempty,min=1,max=255 browser: type: string x-oapi-codegen-extra-tags: validate: omitempty,min=1,max=255 customTag1: type: string x-oapi-codegen-extra-tags: validate: omitempty,min=1,max=255 customTag2: type: string x-oapi-codegen-extra-tags: validate: omitempty,min=1,max=255 customTag3: type: string x-oapi-codegen-extra-tags: validate: omitempty,min=1,max=255 customTag4: type: string x-oapi-codegen-extra-tags: validate: omitempty,min=1,max=255 customTag5: type: string x-oapi-codegen-extra-tags: validate: omitempty,min=1,max=255 customTag6: type: string x-oapi-codegen-extra-tags: validate: omitempty,min=1,max=255 customTag7: type: string x-oapi-codegen-extra-tags: validate: omitempty,min=1,max=255 customTag8: type: string x-oapi-codegen-extra-tags: validate: omitempty,min=1,max=255 customTag9: type: string x-oapi-codegen-extra-tags: validate: omitempty,min=1,max=255 customTag10: type: string x-oapi-codegen-extra-tags: validate: omitempty,min=1,max=255 customTag11: type: string x-oapi-codegen-extra-tags: validate: omitempty,min=1,max=255 customTag12: type: string x-oapi-codegen-extra-tags: validate: omitempty,min=1,max=255 customTag13: type: string x-oapi-codegen-extra-tags: validate: omitempty,min=1,max=255 customTag14: type: string x-oapi-codegen-extra-tags: validate: omitempty,min=1,max=255 customTag15: type: string x-oapi-codegen-extra-tags: validate: omitempty,min=1,max=255 customTag16: type: string x-oapi-codegen-extra-tags: validate: omitempty,min=1,max=255 customTag17: type: string x-oapi-codegen-extra-tags: validate: omitempty,min=1,max=255 customTag18: type: string x-oapi-codegen-extra-tags: validate: omitempty,min=1,max=255 customTag19: type: string x-oapi-codegen-extra-tags: validate: omitempty,min=1,max=255 customTag20: type: string x-oapi-codegen-extra-tags: validate: omitempty,min=1,max=255 experimentRunID: type: string description: Experiment run ID (format `exr-`). x-oapi-codegen-extra-tags: validate: omitempty,id=exr experimentVariantID: type: string description: Experiment variant ID (format `exv-`). x-oapi-codegen-extra-tags: validate: omitempty,id=exv observeAnnotationSource: type: string enum: - manual - agent - system description: Who wrote the annotation or made a change. observeAnnotationEvidence: type: string enum: - code - trace - data - customer description: Kind of evidence an annotation rests on. observeAnnotationRef: type: object required: - type - value properties: type: type: string enum: - finding - annotation - project - commit - release - url description: What the reference points to. x-oapi-codegen-extra-tags: validate: required,oneof=finding annotation project commit release url value: type: string description: >- Finding, annotation or project ID, commit SHA, release name or absolute URL. x-oapi-codegen-extra-tags: validate: required,min=1,max=2000 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. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.