---
title: "OnlineFormTypes.list"
method: GET
path: "/entities/OnlineFormTypes"
tags: ["Online"]
---

# OnlineFormTypes.list

`GET /entities/OnlineFormTypes`

Returns all defined OnlineFormTypes

## 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 OnlineFormTypes

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` OnlineFormType[]
    - `has_draft` boolean, required — Set to True if draft for entity exists and can be published
    - `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.
    - `form_edit_api` object, required — API-friendly view of the form definition merged with any pending draft changes. Read-only; modify form_edit through drafts.
    - `can_change_readonly` boolean — Returns if user can change readonly flag on this entity_type.
    - `id` string, uuid, required — Unique identifier of entity.
    - `is_deleted` boolean — Specifies if the entity is considered deleted.
    - `modified` string, date-time — Last modification time.
    - `created` string, date-time — Creation time.
    - `owner` string, uri, required — User who owns the online form. Relation to Client. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Client' object for properties.
    - `style` string, uri, required — Visual style applied to the form when rendered. Relation to OnlineFormStyle. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OnlineFormStyle' object for properties.
    - `auto_prefill_with_javascript` boolean — When true, the embedded form JavaScript pre-fills fields from URL query parameters on load.
    - `description` string — Free-text description shown alongside the form definition in the UI.
    - `entity_api_name` string — API name of the custom entity the form targets. Set only when entity_type is CustomEntity; otherwise empty.
    - `entity_type` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12, required — Field whose values are strictly defined with an enumeration of values. 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
    - `form_edit` object, required — Definition of the form layout (fields, sections, settings) shown to respondents, as a JSON object conforming to the online-form layout schema. Validated on write.
    - `is_enabled` boolean, required — When true, the form is published and accepts new submissions; when false, the form returns an error to respondents.
    - `is_readonly` boolean, required — True when the form is system-managed and its schema cannot be edited by users.
    - `last_schema_change` string, date-time — Timestamp of the most recent change to form_edit (form schema).
    - `last_status_change` string, date-time — Timestamp of the most recent change to is_enabled.
    - `name` string, required — Name of the entity and its default text representation.
    - `notifications_status` object — Tracks which threshold-reached notifications have already been sent for the current form configuration. Reset when the configuration changes.
    - `owner_id` string, uuid, required — Id of the owning user.
    - `style_id` string, uuid, required — Id of the form style.
    - `revision` integer — Revision when entity was lastly changed.
    - `activity_logs` string[] — Submissions (one per response) recorded for this form.
    - `link_id` string, required — Short identifier used in the public form URL (see link). Stable across the lifetime of the form.
    - `summarized_response_values` integer — Sum of response values used to evaluate the response acceptance threshold (e.g. total responses, or evaluated value of the custom acceptance condition). Empty when no threshold is configured.
    - `link` string — Public URL for accessing the form (suitable for sharing with respondents).
    - `has_custom_recaptcha` boolean, required — True when the form is configured with custom reCAPTCHA credentials; false when using the platform default reCAPTCHA setup.
  - `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)