---
title: "Types.list"
method: GET
path: "/entities/Types"
tags: ["Type"]
---

# Types.list

`GET /entities/Types`

Returns all defined Types

## Query parameters

- `include-deleted` boolean
- `first` integer
- `last` integer
- `before` string
- `after` string
- `expand` string
- `order-by` string
- `filter` object
- `filter-op` object
- `load-only` string

## Response `200`

list of Types

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` Type[]
    - `is_delete_protected` boolean, required — Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.
    - `id` string, required — Unique identifier of entity.
    - `primitive_type` 'blob' | 'bool' | 'date' | 'datetime' | 'decimal' | 'double' | 'dynamic' | 'enum' | 'int' | 'list' | 'object' | 'string' | 'uuid' | 'tsvector', required — Field whose values are strictly defined with an enumeration of values.
    - `validator` object — Validation rules applied to values of this type (e.g. max length, regex, allowed enum values), as a JSON document.
    - `flag` integer, required — This field is bit flag which determinate purpose of the field and his abilities on form, following options are allowed CUSTOM_ALLOWED = 1 # field of this type can be created as new custom field CALC_ALLOWED = 2 # field can have calculation formula defined DEFAULT_ALLOWED = 4 # field can have default value defined MOBILE_ALLOWED = 8 # field can be displayed on form FIELD_MAP_REQUIRED = 16 # Obsolete FORM_FORBIDDEN = 32 # field of this type can't be located on form READONLY_ALLOWED = 64 # field can be defined as readonly on form ONLY_MAIN_FORM = 128 # field can be only at FORM_EDIT form not on e.g FORM_LOST ALLOWED_IN_CALC_FORMULA = 256 # field can be used within calculation expression MUST_BE_ON_FORM = 512 # field of this type can't be removed from form
    - `default_value` string — Default value applied to fields of this type when no value is supplied at create-time. Empty when the type has no default.
    - `relation_type` 0 | 1 | 2, required — Cardinality of the relation when the type represents a relation (e.g. one-to-one, many-to-one). Integer enum value: 0 - NO_RELATION, 1 - MANY_TO_ONE_SCALAR, 2 - MANY_TO_MANY_VECTOR
    - `container_size` integer, required — Maximum length or capacity for fields of this type (e.g. string max-length).
    - `is_groupable` boolean, required — True when fields of this type can be used as a grouping column in reports.
    - `is_filterable` boolean, required — True when fields of this type can be used in filters.
    - `is_sortable` boolean, required — True when fields of this type can be used to sort records.
    - `is_selectable` boolean, required — True when fields of this type can be selected in queries.
  - `page_info` object — Page info result set. Please note it is returned only when legacy limit & offset parameters are not used.
    - `start_cursor` string — Start cursor of result set.
    - `end_cursor` string — End cursor of result set.
    - `has_previous_page` boolean — If result set has previous page (if yes, use start_cursor value in before parameter to load it).
    - `has_next_page` boolean — If result set has next page (if yes, use end_cursor value in after parameter to load it).

## Other responses

- `500` — unexpected error

---

[API](https://skmtc.dev/aws/apis/pipeliner-cloud-api.md) · [All operations](https://skmtc.dev/aws/apis/pipeliner-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/aws/pipeliner-cloud-api/revisions/e8c12ae60aca/schema)