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

# OnlineForms.list

`GET /entities/OnlineForms`

Returns all defined OnlineForms

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

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` OnlineForm[]
    - `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.
    - `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.
    - `currency_exchange_rates_list` string, uri — Currency exchange rate list applied to product line-items at submission time. Relation to CurrencyExchangeRatesList. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'CurrencyExchangeRatesList' object for properties.
    - `email` string, uri — Email submitted with the response, used for identification or response notifications. Relation to Email. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Email' object for properties.
    - `online_form_type` string, uri, required — Online form definition this submission belongs to. Relation to OnlineFormType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'OnlineFormType' object for properties.
    - `product_currency` string, uri, required — Currency selected by the respondent for product line-items, when the form contains products. Relation to Currency. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'Currency' object for properties.
    - `product_price_list` string, uri — Product price list selected by the respondent, when the form contains products. Relation to ProductPriceList. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'ProductPriceList' object for properties.
    - `currency_exchange_rates_list_id` string, uuid — Id of the exchange rate list.
    - `email_id` string, uuid — Id of the linked email record, when available.
    - `field_ids` object, required — Ids of the fields included in the form when this submission was captured, as a JSON array of field ids (UUIDs).
    - `online_form_type_id` string, uuid, required — Id of the online form definition.
    - `product_currency_id` string, uuid — Id of the selected currency.
    - `product_price_list_id` string, uuid — Id of the selected price list.
    - `status` 1 | 2 | 3 | 4 | 5 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Ok, 2 - Warning, 3 - Error, 4 - Scheduled, 5 - Expired
    - `revision` integer — Revision when entity was lastly changed.
    - `account_relations` string[] — Accounts the submission was linked to.
    - `contact_relations` string[] — Contacts the submission was linked to.
    - `lead_relations` string[] — Leads the submission was linked to.
    - `opportunity_relations` string[] — Opportunities the submission was linked to.
    - `quote_relations` string[] — Quotes the submission was linked to.
    - `project_relations` string[] — Projects the submission was linked to.
    - `custom_entity_relations` string[] — Custom entity records the submission was linked to.
    - `lines` string[] — Activity log lines describing what was done with this submission (visible only).
    - `responded_by` string, required — Display name of the primary record (account/contact/lead/...) the submission was linked to.
    - `response_date` string, date-time — Timestamp the submission was received (the response was completed).
  - `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.net/aws/apis/pipeliner-cloud-api.md) · [All operations](https://skmtc.net/aws/apis/pipeliner-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/pipeliner-cloud-api/revisions/e8c12ae60aca/schema)