InterfacePreviews.list

Returns all defined InterfacePreviews

Request

Query Params

include-deleted

boolean

optional

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

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

array[object (InterfacePreview) {35}]

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

read-onlyoptional

Specifies if the entity is considered deleted.

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

account_type

string <uri>

optional

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

appointment_type

string <uri>

optional

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

contact_type

string <uri>

optional

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

custom_entity_type

string <uri>

optional

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

lead_type

string <uri>

optional

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

oppty_type

string <uri>

optional

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

product_type

string <uri>

optional

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

project_type

string <uri>

optional

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

quote_type

string <uri>

optional

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

task_type

string <uri>

optional

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

account_type_id

string <uuid>

read-onlyoptional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

appointment_type_id

string <uuid>

read-onlyoptional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

card_field_ids

object

required

charts

object

required

Field containing json.

contact_type_id

string <uuid>

read-onlyoptional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

custom_entity_type_id

string <uuid>

read-onlyoptional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

detail_tabs

object

required

Field containing json.

detail_widgets

object

required

Field containing json.

field_ids

object

required

lead_type_id

string <uuid>

read-onlyoptional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

oppty_type_id

string <uuid>

read-onlyoptional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

product_type_id

string <uuid>

read-onlyoptional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

project_type_id

string <uuid>

read-onlyoptional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

quote_type_id

string <uuid>

read-onlyoptional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

task_type_id

string <uuid>

read-onlyoptional

Relation to single entity instance.

Example:

01234567-abcd-dcba-ffff-000000000000

is_published

boolean

read-onlyoptional

Example:

false

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

entity_type_id

string <uuid>

read-onlyrequired

Example:

01234567-abcd-dcba-ffff-000000000000

entity_type

enum<integer>

required

Integer enum value: 1 - Lead, 2 - Account, 3 - Contact, 4 - Opportunity, 5 - Task, 6 - Appointment, 7 - OpptyProductRelation, 8 - Project, 9 - Quote, 10 - OnlineForm, 11 - CustomEntity, 12 - Product

Allowed values:

123456789101112

Example:

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",
      "account_type": "http://example.com",
      "appointment_type": "http://example.com",
      "contact_type": "http://example.com",
      "custom_entity_type": "http://example.com",
      "lead_type": "http://example.com",
      "oppty_type": "http://example.com",
      "product_type": "http://example.com",
      "project_type": "http://example.com",
      "quote_type": "http://example.com",
      "task_type": "http://example.com",
      "account_type_id": "01234567-abcd-dcba-ffff-000000000000",
      "appointment_type_id": "01234567-abcd-dcba-ffff-000000000000",
      "card_field_ids": {},
      "charts": {},
      "contact_type_id": "01234567-abcd-dcba-ffff-000000000000",
      "custom_entity_type_id": "01234567-abcd-dcba-ffff-000000000000",
      "detail_tabs": {},
      "detail_widgets": {},
      "field_ids": {},
      "lead_type_id": "01234567-abcd-dcba-ffff-000000000000",
      "oppty_type_id": "01234567-abcd-dcba-ffff-000000000000",
      "product_type_id": "01234567-abcd-dcba-ffff-000000000000",
      "project_type_id": "01234567-abcd-dcba-ffff-000000000000",
      "quote_type_id": "01234567-abcd-dcba-ffff-000000000000",
      "task_type_id": "01234567-abcd-dcba-ffff-000000000000",
      "is_published": false,
      "revision": 1,
      "entity_type_id": "01234567-abcd-dcba-ffff-000000000000",
      "entity_type": 1
    }
  ],
  "page_info": {
    "start_cursor": "WyIwMSIsICJiMmYwODI0Ni1iYWE5LTQyY2QtYmM3Yi04YmM4MjY3M2E2NTgiXQ==",
    "end_cursor": "WyIwNSIsICJmMjZhZjZiMC00ZWE4LTQ3MDgtODU2NC0wN2JmYzI4ZGQ5ZTgiXQ==",
    "has_previous_page": true,
    "has_next_page": true
  }
}

🔴500Server Error

Request

Request samples

Responses