---
title: "Webresources.list"
method: GET
path: "/entities/Webresources"
tags: ["Webresource"]
---

# Webresources.list

`GET /entities/Webresources`

Returns all defined Webresources

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

- object
  - `success` boolean — True when response succeeded, false on error.
  - `data` Webresource[]
    - `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.
    - `has_draft` boolean, required — Set to True if draft for entity exists and can be published
    - `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.
    - `display_param` string, required — Bit flag controlling how the web resource is displayed (e.g. full-screen, in a tab).
    - `entity` string, required — Name of the entity the web resource is attached to (e.g. "Account", "Lead").
    - `name` string, required — Name of the entity and its default text representation.
    - `request_method` 1 | 2 — Field whose values are strictly defined with an enumeration of values. Integer enum value: 1 - Get, 2 - Post
    - `url` string — URL template for the embedded web resource. May reference field values via "{#<field_id>}" placeholders that are substituted with the current record's values.
    - `is_published` boolean — True when the web resource is published; false while it exists only as an unpublished draft.
    - `revision` integer — Revision when entity was lastly changed.
  - `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)