---
title: List
url: https://www.tines.com/stories/docs/api/records/record_types/list/
updated: 2026-08-19T11:05:24+00:00
description: Retrieve a list of record types.
---

*[tines.com](https://www.tines.com/llms.txt) › [Docs](https://www.tines.com/stories/docs/llms.txt) › [Tines API](https://www.tines.com/stories/docs/api/llms.txt) › [Records](https://www.tines.com/llm/stories/docs/api/records.md) › [Record types](https://www.tines.com/llm/stories/docs/api/records/record_types.md)*

# List

*[View on tines.com](https://www.tines.com/stories/docs/api/records/record_types/list/)*

## Description

Retrieve a list of record types.

See the [Get Record Type API](/api/records/record_types/get) to learn more about record types.

## Request

HTTP Method: **GET**

| Query parameter | Description                                                               |
| --------------- | ------------------------------------------------------------------------- |
| team_id         | ID of team to which the record type belongs.                              |
| per_page        | **Optional** Set the number of results returned per page. Defaults to 20. |
| page            | **Optional** The page number of results to fetch.                         |

```bash
curl -X GET \
  https://<tenant-domain>/api/v1/record_types?team_id=<<team_id>> \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'
```

## Response

A successful request will return a JSON Array describing record types in the specified team.

### Field description

| Parameter             | Description                                                                                                                                                             |
| --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id                    | The record type ID.                                                                                                                                                     |
| name                  | The record type name.                                                                                                                                                   |
| description           | A short description of the record type, or null if not set.                                                                                                             |
| team_id               | ID of team to which the record type belongs.                                                                                                                            |
| editable              | Whether the records for this record type are editable or not.                                                                                                           |
| ttl_days              | Records for this record type will be deleted after this number of days.                                                                                                 |
| retention_column_name | The timestamp column used to determine record age for TTL expiry. One of `CREATED_AT` or `UPDATED_AT`. With `UPDATED_AT`, a record's age resets each time it's updated. |
| on_limit_reached      | Behavior when the record type reaches its per-type record limit. One of `REJECT` (block new writes) or `EVICT_OLDEST` (delete the oldest record to make room).          |
| max_records_limit     | Custom per-record-type record limit, or `null` if no custom limit is set (in which case the tenant default applies).                                                    |
| record_fields         | An array of objects describing the custom record fields defined by the user.                                                                                            |
| default_record_fields | An array of objects describing the built-in default record fields.                                                                                                      |

### Sample response

```json
{
  "record_types": [
    {
      "id": 1,
      "name": "Alerts",
      "description": "Alerts from external sources",
      "team_id": 123,
      "editable": false,
      "ttl_days": 3,
      "retention_column_name": "UPDATED_AT",
      "on_limit_reached": "EVICT_OLDEST",
      "max_records_limit": 5000,
      "record_fields": [
        {
          "id": 1,
          "name": "Severity",
          "description": "Text enum, one of low/medium/high",
          "result_type": "TEXT_ENUM",
          "fixed_values": ["low", "medium", "high"]
        }
      ],
      "default_record_fields": [
        {
          "id": 2,
          "name": "Record ID",
          "description": null,
          "result_type": "NUMBER",
          "fixed_values": []
        },
        {
          "id": 3,
          "name": "Story name",
          "description": null,
          "result_type": "TEXT",
          "fixed_values": []
        },
        {
          "id": 4,
          "name": "Timestamp",
          "description": null,
          "result_type": "TIMESTAMP",
          "fixed_values": []
        },
        {
          "id": 5,
          "name": "Updated at",
          "description": null,
          "result_type": "TIMESTAMP",
          "fixed_values": []
        }
      ]
    }
  ],
  "meta": {
    "current_page": "https://<tenant-domain>/api/v1/record_types?per_page=20&page=1",
    "previous_page": null,
    "next_page": null,
    "next_page_number": null,
    "per_page": 20,
    "pages": 1,
    "count": 1
  }
}
```