---
title: "List records"
method: GET
path: "/beta/intelligence/records"
tags: ["Intelligence"]
---

# List records

`GET /beta/intelligence/records`

## Request

- Base URL: `https://dev.dixa.io`
- URL: `https://dev.dixa.io/beta/intelligence/records`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/dixa/apis/dixa-api/docs/beta/intelligence/records/get.ts> (a function with typed inputs; its response is checked against the schema)

List the records you can query, with the fields and filters of each record and the metrics based on it. Use the record `id` with Query conversation records, Query agent records or Query AI agent records.

## Query parameters

- `category` 'conversations' | 'agents' | 'aiagents'
- `pageKey` string
- `pageLimit` integer

## Response `200`

The list of records

- IntelligenceRecordCatalogue
  - `data` RecordCatalogueEntry[]
    - `id` string, required: The record id, used in the URL when you query the record
    - `name` string, required: The display name
    - `category` string, required: `conversations`, `agents` or `aiagents`. Decides which endpoint you query the record with
    - `description` string, required: A short description of the record
    - `deprecated` boolean, required: Whether the record will be removed. A deprecated record can still be queried
    - `primaryFilters` string[]: The keys the `primaryFilter` of a query supports: `period`, `conversationIds` or both
    - `filters` FilterDescriptor[]: The filters the record supports
      - `attribute` string, required: The value to use as a filter's `attribute`
      - `aliases` string[]: Other names you can use for the attribute. Responses always use `attribute`
      - `type` 'String' | 'Integer' | 'Number' | 'Boolean' | 'Uuid' | 'Timestamp' | 'Entity' | 'List' | 'Object', required: The type of the filter values
      - `operators` string[]: The operators the attribute supports
      - `defaultOperator` 'IsEmpty' | 'IsNotEmpty' | 'IsOne' | 'IsNotOne' | 'IsAll' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual', required: The operator used when a filter has no `operator`
      - `description` string, required: A description of the filter
    - `fields` RecordField[]: The columns a row can contain. A nullable column can be left out of a row
      - `name` string, required: The key of the column in a row
      - `type` 'String' | 'Integer' | 'Number' | 'Boolean' | 'Uuid' | 'Timestamp' | 'Entity' | 'List' | 'Object', required: The type of the column value
      - `nullable` boolean, required: Whether the column can be left out of a row
      - `description` string, required: A description of the column
      - `unit` string: The unit of the value, such as milliseconds. Not set when the value has no unit
      - `idType` 'Uuid' | 'String' | 'Integer': The id type. Only set when the column is a reference
      - `items` RecordFieldItems: The type of the list items. Only set for list fields
        - `type` 'String' | 'Integer' | 'Number' | 'Boolean' | 'Uuid' | 'Timestamp' | 'Entity' | 'List' | 'Object', required: The item type
        - `idType` 'Uuid' | 'String' | 'Integer': The id type. Only set when the items are references
    - `relatedMetricIds` string[]: The metrics based on the record
  - `meta` PaginationLinks
    - `previous` string: url
    - `next` string: url

## Other responses

- `400`
- `404`: An entity in this request could not be found
- `500`: Internal failure during request processing

## Changes

- **2026-10-19** `2c1d0ef4a36d`: 1 info
  - added the new enum value `aiagents` to the `query` request parameter `category`
- **2026-10-19** `b492695788bb`: 8 info
  - removed the `Between` enum value from the `data/items/filters/items/defaultOperator` response property for the response status `200`
  - removed the `Between` enum value from the `data/items/filters/items/operators/items/` response property for the response status `200`
  - removed the `Equals` enum value from the `data/items/filters/items/defaultOperator` response property for the response status `200`
  - removed the `Equals` enum value from the `data/items/filters/items/operators/items/` response property for the response status `200`
  - …4 more
- **2026-10-14** `9e01458f1a5f`: 59 warning, 61 info
  - added the new `Between` enum value to the `data/items/filters/items/defaultOperator` response property for the response status `200`
  - added the new `Between` enum value to the `data/items/filters/items/operators/items/` response property for the response status `200`
  - added the new `Boolean` enum value to the `data/items/fields/items/items/type` response property for the response status `200`
  - added the new `Boolean` enum value to the `data/items/fields/items/type` response property for the response status `200`
  - …116 more
- **2026-09-23** `eab8fd8df708`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/dixa/apis/dixa-api/changes/beta/intelligence/records/get.md)

---

[API](https://skmtc.dev/dixa/apis/dixa-api.md) - [All operations](https://skmtc.dev/dixa/apis/dixa-api/llms.txt) - [OpenAPI document](https://skmtc.dev/dixa/apis/dixa-api/revisions/4c9e4ef864d1?raw)