---
title: "Catalog of Fulcra Data Types"
method: GET
path: "/data/v1/catalog"
tags: ["data"]
---

# Catalog of Fulcra Data Types

`GET /data/v1/catalog`

## Request

- Base URL: `https://api.fulcradynamics.com`
- URL: `https://api.fulcradynamics.com/data/v1/catalog`
- Auth: HTTP bearer

## Query parameters

- `data_type` string, nullable
- `category` string, nullable
- `fulcra_userid` string, uuid, nullable

## Response `200`

Successful Response

- CustomFulcraDataType[]
  - `api_version` 'v0' | 'v1alpha1' | 'v1', required: fulcra API versions
  - `categories` FulcraCategory[], required: Categories this data type belongs to
  - `class` 'metric' | 'event' | 'location' | 'entry' | 'tombstone', required: Fulcra record types
  - `column_name` string, required: Name of data column as returned by Fulcra APIs
  - `deprecated` boolean: Whether this type is deprecated
  - `description` string, required: Human-readable description
  - `fulcra_userid` string, uuid, required
  - `icon` string, nullable: Icon identifier
  - `id` string, required: Programmatic Identifier
  - `metric_kind` 'cumulative' | 'discrete', required: fulcra metric aggregation
  - `name` string, required: Human-readable name
  - `queryable` boolean: Denotes if this type can be queried
  - `record_spec` union, required: Metadata about the data that is recorded and queried
    - FulcraEventRecord: spec metadata for a fulcra event record
      - `schema` object, nullable
      - `type` 'event': Record Type
    - FulcraMetricRecord: represents the type or 'shape' of a record for a fulcra data type
      - `aggregation` 'cumulative' | 'discrete', required: fulcra metric aggregation
      - `scale` FulcraMetricRecordScale
        - `max` integer, required
        - `min` integer, required
        - `step` integer, required
      - `schema` object, nullable
      - `type` 'metric': Record Type
      - `unit` string, nullable: Unit of measurement
      - `value_map` object, nullable: Map of metric values to human readable descriptors
    - FulcraLocationRecord: spec metadata for a fulcra location record
      - `schema` object, nullable
      - `type` 'location': Record Type
    - FulcraTombstoneRecord: spec metadata for a fulcra tombstone (aka deleted record)
      - `schema` object, nullable
      - `type` 'tombstone': Record Type
  - `recordable` boolean: Denotes if this type can be recorded
  - `unit` string, nullable, 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)