Fields.list

Returns all defined Fields

Request

Query Params

include-deleted

boolean

optional

if enabled, deleted Fields 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

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

Responses

🟢200OK

application/json

list of Fields

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

array[object (Field) {46}]

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

has_draft

boolean

required

Set to True if draft for entity exists and can be published

Example:

false

string <uuid>

read-onlyrequired

Unique identifier of entity.

Example:

01234567-abcd-dcba-ffff-000000000000

is_deleted

boolean

optional

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

Example:

false

modified

string <date-time>

read-onlyoptional

Last modification time.

Example:

2019-01-01T00:00:00

created

string <date-time>

read-onlyoptional

Creation time.

Example:

2019-01-01T00:00:00

entity_name

string

read-onlyrequired

Related entity name for field (e.g. Account, Contact, Lead, Opportunity, ...)

Example:

string

api_name

string

optional

Immutable and generated name. This name is used for integrations.

Example:

string

name

string

required

User friendly name for field.

Example:

string

use_lang

integer <int32>

optional

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

Example:

column_name

string

optional

Simple text input field.

Example:

string

column_source

integer <int32>

read-onlyoptional

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

Example:

relation_id

string

optional

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

Example:

string

relation_with_entity_id

string

optional

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

Example:

string

shared_with_field_id

string <uuid>

optional

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

Example:

01234567-abcd-dcba-ffff-000000000000

system_type

integer <int32>

read-onlyoptional

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

Example:

type_id

string

required

Type of the field. Supported field types are: checkbox, currency, currency_foreign, date, datetime, dropdown, email, float, input, integer, multiselect_checkbox, phone, radio, sequence, text_area, url

Example:

string

composite_field_id

string <uuid>

optional

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

Example:

01234567-abcd-dcba-ffff-000000000000

data_set_id

string <uuid>

optional

Optional custom data set id can be set.

Example:

01234567-abcd-dcba-ffff-000000000000

parent_data_set_id

string <uuid>

optional

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

Example:

01234567-abcd-dcba-ffff-000000000000

calc_formula

string

optional

Calculated formula used for fields which supports calculation.

Example:

string

default_value

string

optional

A default value for field.

Example:

string

sequence_id

string <uuid>

optional

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

Example:

01234567-abcd-dcba-ffff-000000000000

system_required

boolean

read-onlyoptional

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

Example:

false

is_published

boolean

read-onlyoptional

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

Example:

false

system_readonly

boolean

read-onlyoptional

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

Example:

false

use_in_global_search

boolean

optional

If this field is allowed in global search.

Example:

false

settings

object

optional

Field containing json.

is_unique

boolean

read-onlyoptional

If true, then there will be an API validation if value of entity is unique.

Example:

false

data_set

string <uri>

required

Relation to Data. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Data' object for properties.

sequence_pattern

string

optional

A sequence pattern used for sequence type of field.

Example:

string

lookup

object

optional

Lookup field definition.

rollup

object

optional

Rollup field definition.

options

object

optional

advanced_formula

object

optional

Advanced calculated formula

source_field_id

string

required

Example:

string

source_type_id

string

required

Example:

string

use_in_interface_preview

boolean

required

Example:

false

translated_name

string

required

Example:

string

field_permissions

string <uri>

required

Relation to Data. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Data' object for properties.

original_dataset_field_id

string <uuid>

optional

Example:

01234567-abcd-dcba-ffff-000000000000

name_translations

string <binary>

required

Example:

blob

name_translated

string

required

Example:

string

primitive_type

string

required

Example:

string

is_available_for_webresource

boolean

required

Example:

false

is_available_for_advanced_formula

boolean

required

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,
      "has_draft": false,
      "id": "01234567-abcd-dcba-ffff-000000000000",
      "is_deleted": false,
      "modified": "2019-01-01T00:00:00",
      "created": "2019-01-01T00:00:00",
      "entity_name": "string",
      "api_name": "string",
      "name": "string",
      "use_lang": 1,
      "column_name": "string",
      "column_source": 1,
      "relation_id": "string",
      "relation_with_entity_id": "string",
      "shared_with_field_id": "01234567-abcd-dcba-ffff-000000000000",
      "system_type": 1,
      "type_id": "string",
      "composite_field_id": "01234567-abcd-dcba-ffff-000000000000",
      "data_set_id": "01234567-abcd-dcba-ffff-000000000000",
      "parent_data_set_id": "01234567-abcd-dcba-ffff-000000000000",
      "calc_formula": "string",
      "default_value": "string",
      "sequence_id": "01234567-abcd-dcba-ffff-000000000000",
      "system_required": false,
      "is_published": false,
      "system_readonly": false,
      "use_in_global_search": false,
      "settings": {},
      "is_unique": false,
      "data_set": "http://example.com",
      "sequence_pattern": "string",
      "lookup": {},
      "rollup": {},
      "options": {},
      "advanced_formula": {},
      "source_field_id": "string",
      "source_type_id": "string",
      "use_in_interface_preview": false,
      "translated_name": "string",
      "field_permissions": "http://example.com",
      "original_dataset_field_id": "01234567-abcd-dcba-ffff-000000000000",
      "name_translations": "blob",
      "name_translated": "string",
      "primitive_type": "string",
      "is_available_for_webresource": false,
      "is_available_for_advanced_formula": false
    }
  ],
  "page_info": {
    "start_cursor": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==",
    "end_cursor": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==",
    "has_previous_page": true,
    "has_next_page": true
  }
}

🔴500Server Error

Request

Request samples

Responses