Types.list

GET

/entities/Types

Type

Returns all defined Types

Request

Query Params

include-deleted

boolean

optional

if enabled, deleted Types are returned as well

first

integer <int32>

optional

Number of entities to return from beginning of the result set. Max: 100. Default: 30

last

integer <int32>

optional

Return only the "last" number of entities from result set. When used with first parameter, then it returns last M records from the first N records.

before

string

optional

Cursor until which to take entities to result set.

after

string

optional

Cursor after which to start taking entities to result set.

expand

string

optional

Expand related entity. Use api_names of relation fields. You can use multiple values separated via ',' colon. If not used, URI link will be returned instead. You can use dots '.' to expand nested entities as well.

Example:

expand=owner,sales_unit,account_relations.account

order-by

string

optional

Order by values. Use api_name of field to sort by ascending. Prefix api_name with '-' to descending sort. You can use multiple values separated via ',' colon.

Example:

order-by=created,-modified

filter

object

optional

Use name of field in braces to filter by this field. To advanced filter, use with combination with filter-op parameter.

filter-op

object

optional

Filter operator. Specify a way how to filter fields. Supported operators: [eq, ieq, not-eq, not-ieq, contains, starts, ends, icontains, istarts, iends, null, not-null, empty, not-empty, gt, gte, lt, lte, between].

load-only

string

optional

Loads only fields defined within this parameter. You can use multiple values separated via ',' colon. If not used, then all fields are returned. You can use dots '.' to specify load only fields in nested as well.

Example:

load-only=id,name,owner.id

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

list of Types

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

array[object (Type) {12}]

optional

is_delete_protected

boolean

read-onlyrequired

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.

Example:

false

string

read-onlyrequired

Unique identifier of entity.

Example:

string

primitive_type

enum<string>

read-onlyrequired

Field whose values are strictly defined with an enumeration of values.

Allowed values:

blobbooldatedatetimedecimaldoubledynamicenumintlistobjectstringuuid

Example:

blob

validator

object

read-onlyoptional

Field containing json.

flag

integer <int32>

read-onlyrequired

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

Example:

default_value

string

read-onlyoptional

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

string

relation_type

enum<integer>

read-onlyrequired

Integer enum value: 0 - NO_RELATION, 1 - MANY_TO_ONE_SCALAR, 2 - MANY_TO_MANY_VECTOR

Allowed values:

012

Example:

container_size

integer <int32>

read-onlyrequired

Generic field wrapping sqlalchemy column, configurable by constructor.
Good for one-of fields / generated fields.

Example:

is_groupable

boolean

read-onlyrequired

Boolean value.

Example:

false

is_filterable

boolean

read-onlyrequired

Boolean value.

Example:

false

is_sortable

boolean

read-onlyrequired

Boolean value.

Example:

false

is_selectable

boolean

read-onlyrequired

Boolean value.

Example:

false

page_info

object

optional

Page info result set. Please note it is returned only when legacy limit & offset parameters are not used.

start_cursor

string

optional

Start cursor of result set.

Example:

WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==

end_cursor

string

optional

End cursor of result set.

Example:

WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==

has_previous_page

boolean

optional

If result set has previous page (if yes, use start_cursor value in before parameter to load it).

Example:

true

has_next_page

boolean

optional

If result set has next page (if yes, use end_cursor value in after parameter to load it).

Example:

true

Example

{
    "success": true,
    "data": [
        {
            "is_delete_protected": false,
            "id": "string",
            "primitive_type": "blob",
            "validator": {},
            "flag": 1,
            "default_value": "string",
            "relation_type": 0,
            "container_size": 1,
            "is_groupable": false,
            "is_filterable": false,
            "is_sortable": false,
            "is_selectable": false
        }
    ],
    "page_info": {
        "start_cursor": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==",
        "end_cursor": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==",
        "has_previous_page": true,
        "has_next_page": true
    }
}

🔴500Server Error

Types.get

UnsubscribedPhones.get