---
title: "Types.get"
method: GET
path: "/entities/Types/{id}"
tags: ["Field"]
---

# Types.get

`GET /entities/Types/{id}`

## Request

- Base URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id`
- URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id/entities/Types/{id}`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/coevera/apis/coevera-crm-api/docs/entities/Types/:id/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the Type record with the given id.

## Path parameters

- `id` string, uuid, required

## Query parameters

- `expand` string

## Response `200`

The Type record.

- object
  - `success` boolean: True when the request succeeded; false on error.
  - `data` Type: Data type of fields, defining the kind of value, its validation and whether fields of the type can be filtered, sorted or grouped.
    - `is_delete_protected` boolean, required: True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
    - `id` string, required: Unique identifier of entity.
    - `primitive_type` 'blob' | 'bool' | 'date' | 'datetime' | 'decimal' | 'double' | 'dynamic' | 'enum' | 'int' | 'list' | 'object' | 'string' | 'uuid' | 'tsvector', required: Underlying data type of values of this field type, such as STRING, DECIMAL or DATETIME. Read-only.
    - `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: What fields of this type can do, as a sum of flags: 1 - can be a custom field, 2 - can have a calculation formula, 4 - can have a default value, 8 - can be shown on mobile, 16 - needs a field mapping, 32 - cannot be placed on forms, 64 - can be read-only on forms, 128 - only on the main form, 256 - can be used in calculation formulas, 512 - must stay on the form, 1024 - searchable in global search, 2048 - needs a calculation formula, 4096 - can be used in advanced calculation formulas.
    - `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: Whether fields of this type hold a plain value (NO_RELATION), a reference to one related record (MANY_TO_ONE_SCALAR) or a collection of related records (MANY_TO_MANY_VECTOR). 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.

## Other responses

- `400`: Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check `code`.
- `401`: Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED).
- `404`: No such record or entity (code 143 ERROR_NO_ENTITY, or 2006 ERROR_UNKNOWN_TYPE).
- `429`: Too many requests (code 182). Wait for the seconds in Retry-After, then retry.
- `500`: Unexpected server error (code 1000, ERROR_UNKNOWN).

---

[API](https://skmtc.dev/coevera/apis/coevera-crm-api.md) - [All operations](https://skmtc.dev/coevera/apis/coevera-crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/coevera/apis/coevera-crm-api/revisions/40ebbc83f179?raw)
