---
title: "Get a list of annotations"
method: GET
path: "/user/v1alpha1/annotation"
tags: ["annotations"]
deprecated: true
---

# Get a list of annotations

`GET /user/v1alpha1/annotation`

## Request

- Base URL: `https://api.fulcradynamics.com`
- URL: `https://api.fulcradynamics.com/user/v1alpha1/annotation`
- Auth: HTTP bearer

> **Deprecated.**

Return a list of the user's annotations

## Query parameters

- `fulcra_userid` string, uuid, nullable
- `annotation_type` 'duration' | 'moment' | 'numeric' | 'people' | 'scale' | 'boolean': Represents the base type of an annotation

## Response `200`

Successful Response

- AnnotationRow[]
  - `annotation_type` 'duration' | 'moment' | 'numeric' | 'people' | 'scale' | 'boolean', required: Represents the base type of an annotation
  - `created_at` string, date-time, required
  - `deleted_at` string, date-time, nullable
  - `description` string, required: Description
  - `fulcra_source_id` string, required
  - `fulcra_userid` string, uuid, required
  - `id` string, uuid, required
  - `measurement_spec` union: Measurement spec
    - BooleanMeasurement: Represents a yes or no measurement configuration
      - `boolean` BooleanMeasurementSpec, required
        - `value` boolean, nullable: Default value
      - `measurement_type` 'boolean'
      - `metric_kind` 'cumulative' | 'discrete'
      - `unit` unknown
      - `value_type` 'boolean'
    - CountMeasurement: Represents a count measurement configuration
      - `count` CountMeasurementSpec, required
        - `value` number, nullable: Default value
      - `measurement_type` 'count'
      - `metric_kind` 'cumulative' | 'discrete'
      - `unit` unknown
      - `value_type` 'real'
    - CustomMeasurement: Represents a custom non-convertable measurement configuration
      - `custom` CustomMeasurementSpec, required
        - `value` number, nullable: Default value
      - `measurement_type` 'custom'
      - `metric_kind` 'cumulative' | 'discrete'
      - `unit` string, nullable
      - `value_type` 'real'
    - DistanceMeasurement: Represents a distance or length measurement configuration
      - `distance` DistanceMeasurementSpec, required
        - `value` number, nullable: Default value
      - `measurement_type` 'distance'
      - `metric_kind` 'cumulative' | 'discrete'
      - `unit` 'inch' | 'foot' | 'yard' | 'mile' | 'millimeter' | 'centimeter' | 'meter' | 'kilometer'
      - `value_type` 'real'
    - DurationMeasurement: Represents a time duration measurement configuration
      - `measurement_type` 'duration'
      - `metric_kind` 'cumulative' | 'discrete'
      - `unit` unknown
      - `value_type` 'duration'
    - MassMeasurement: Represents a mass measurement configuration and may be inferred from weight
      - `mass` MassMeasurementSpec, required
        - `value` number, nullable: Default value
      - `measurement_type` 'mass'
      - `metric_kind` 'cumulative' | 'discrete'
      - `unit` 'ounce' | 'pound' | 'microgram' | 'milligram' | 'gram' | 'kilogram' | 'stone'
      - `value_type` 'real'
    - PercentMeasurement: Represents a percentage measurement configuration
      - `measurement_type` 'percent'
      - `metric_kind` 'cumulative' | 'discrete'
      - `percent` PercentMeasurementSpec, required
        - `value` number, nullable: Default value
      - `unit` 'percent'
      - `value_type` 'real'
    - PeriodMeasurement: Represents a time period measurement configuration
      - `measurement_type` 'period'
      - `metric_kind` 'cumulative' | 'discrete'
      - `period` PeriodMeasurementSpec, required
        - `value` number, nullable: Default value
      - `unit` 'second'
      - `value_type` 'real'
    - ScaleMeasurement: Represents a discrete scale measurement configuration with minimum and maximum values
      - `measurement_type` 'scale'
      - `metric_kind` 'cumulative' | 'discrete'
      - `scale` ScaleMeasurementSpec, required
        - `max_allowed` integer, required: Maxiumum value on scale
        - `min_allowed` integer, required: Minimum value on scale
        - `value` integer, nullable: Default value
      - `unit` unknown
      - `value_type` 'integer'
    - TemperatureMeasurement: Represents a temperature measurement configuration
      - `measurement_type` 'temperature'
      - `metric_kind` 'cumulative' | 'discrete'
      - `temperature` TemperatureMeasurementSpec, required
        - `value` number, nullable: Default value
      - `unit` 'degree_celsius' | 'degree_fahrenheit'
      - `value_type` 'real'
    - VolumeMeasurement: Represents a physical volume measurement configuration
      - `measurement_type` 'volume'
      - `metric_kind` 'cumulative' | 'discrete'
      - `unit` 'teaspoon' | 'tablespoon' | 'fluid_ounce' | 'pint' | 'quart' | 'gallon' | 'millileter' | 'liter'
      - `value_type` 'real'
      - `volume` VolumeMeasurementSpec, required
        - `value` number, nullable: Default value
  - `name` string, required: Name
  - `spec` union: Type-specific spec
    - ScaleAnnotationSpecContainerOutput
      - `default_note` string, nullable: Default note text, if any
      - `scale` ScaleAnnotationSpecOutput, required
        - `label_mapping` StringScaleMapping, required: Represents a scale mapping to strings or emojis
          - `mapping_type` 'string'
          - `string` StringScaleMappingSpec, required
            - `mapping` object, required: Mapping of scale values to strings
        - `scale_mapping` union: Display value mappoing for each scale value
          - ColorScaleMappingOutput: Represents a scale mapping to colorrs
            - `color` ColorScaleMappingSpecOutput, required
              - …
            - `mapping_type` 'color'
          - EmojiScaleMappingOutput: Represents a scale mapping to colorrs
            - `color` ColorScaleMappingSpecOutput, required
              - …
            - `mapping_type` 'emoji'
            - `string` StringScaleMappingSpec, required
              - …
    - AnnotationSpecContainer
      - `default_note` string, nullable: Default note text, if any
  - `tags` string[], required: Default tags
  - `updated_at` string, date-time, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/fulcradynamics/apis/fulcra-life-api.md) · [All operations](https://skmtc.dev/fulcradynamics/apis/fulcra-life-api/llms.txt) · [OpenAPI document](https://skmtc.dev/fulcradynamics/apis/fulcra-life-api/revisions/d85136fc304a?raw)