---
title: entities.webresource
description: Read webresource records with the webresource repository, and change them with the webresource mutations. Same records as the REST Webresources entity.
canonical: https://developers.coevera.com/reference/graphql/webresource/
section: graphql
verification: schema
generatedFrom: schema f155746 (2026-10-20)
publisher: Coevera
---

# entities.webresource

Read webresource records with the webresource repository, and change them with the webresource mutations. Same records as the REST Webresources entity.

REST: [Webresources](https://developers.coevera.com/reference/rest/webresources.md).

## Queries

- `getById(entityId: ID!): WebresourceEntity` Returns the record with the given id, or null when there is none. Deleted records are returned as well.
- `getByIds(entityIds: [ID!]!): [WebresourceEntity!]!` Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
- `getAll(limit: Int, offset: Int, filter: WebresourceFilterInput, orderBy: [WebresourceOrderByInput!], includeDeleted: Boolean): [WebresourceEntity!]!` Returns the records that match the filter, paged with limit and offset.
- `getByCriteria(filter: WebresourceFilterInput, orderBy: [WebresourceOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int): WebresourceEntityConnection` Returns the records that match the filter as a cursor-paginated connection.
- `getPublished(limit: Int, offset: Int, filter: WebresourceFilterInput, orderBy: [WebresourceOrderByInput!], includeDeleted: Boolean): [WebresourceEntity!]!` Returns the published records that match the filter, paged with limit and offset.
- `getDrafts(filter: WebresourceFilterInput, orderBy: [WebresourceOrderByInput!]): [WebresourceEntity!]!` Returns the records that match the filter, with pending unpublished changes applied where a draft exists.
- `getDraftById(entityId: ID!): WebresourceEntity!` Returns the record with the given id, with its pending unpublished changes applied when a draft exists.

## Types

### WebresourceEntity (object)

Web page embedded in the app for records of an entity, with its URL filled from the record's field values.

- `isDeleteProtected: Boolean!` True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
- `hasDraft: Boolean` True when the record has unpublished draft changes, including pending translation changes, that can be published.
- `id: ID!` Unique identifier of entity.
- `isDeleted: Boolean` Specifies if the entity is considered deleted.
- `modified: DateTime` Last modification time.
- `created: DateTime` Creation time.
- `displayParam: Int!` Bit flag controlling how the web resource is displayed (e.g. full-screen, in a tab).
- `entity: String!` Name of the entity the web resource is attached to (e.g. "Account", "Lead").
- `name: String!` Name of the entity and its default text representation.
- `requestMethod: RequestMethodEnum` HTTP method (Get or Post) used to open the url of the web resource.
- `url: String` URL template for the embedded web resource. May reference field values via "{#<fieldId>}" placeholders that are substituted with the current record's values.
- `isPublished: Boolean` True when the web resource is published; false while it exists only as an unpublished draft.
- `revision: Int` Revision when entity was lastly changed.
- `instancePermissions: [EntityPermsEnum!]! (1 args)` Permissions the current user has on this record, out of the requested ones.

### WebresourceEntityConnection (object)

Paginated list of Webresource records.

- `pageInfo: PageInfo!` Pagination data for this connection.
- `edges: [WebresourceEntityEdge]!` Contains the nodes in this connection.
- `totalCount: Int` Total number of items in the connection.

### WebresourceEntityEdge (object)

A Relay edge containing a `WebresourceEntity` and its cursor.

- `node: WebresourceEntity` The item at the end of the edge
- `cursor: String!` A cursor for use in pagination

### DisplayParamEnumFilterInput (input)

Conditions on an enumeration field. Several conditions given together must all match.

- `eq: [DisplayParamEnum!]` Matches any of the listed values.
- `NOT: DisplayParamEnumFilterInput` Matches values that do not meet this condition.

### RequestMethodEnumFilterInput (input)

Conditions on an enumeration field. Several conditions given together must all match.

- `eq: [RequestMethodEnum!]` Matches any of the listed values.
- `NOT: RequestMethodEnumFilterInput` Matches values that do not meet this condition.

### WebresourceFilterInput (input)

Filter conditions for Webresource records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

- `OR: [WebresourceFilterInput!]` Matches records that meet at least one of the listed filters.
- `AND: [WebresourceFilterInput!]` Matches records that meet all of the listed filters.
- `NOT: WebresourceFilterInput` Matches records that do not meet this filter.
- `globalSearchQuery: String` Search term matched against the fields that the global search covers for this entity.
- `id: EntityFilterStringField` Unique identifier of entity.
- `isDeleted: Boolean` Specifies if the entity is considered deleted.
- `modified: EntityFilterDateTimeField` Last modification time.
- `created: EntityFilterDateTimeField` Creation time.
- `displayParam: DisplayParamEnumFilterInput` Bit flag controlling how the web resource is displayed (e.g. full-screen, in a tab).
- `entity: EntityFilterStringField` Name of the entity the web resource is attached to (e.g. "Account", "Lead").
- `name: EntityFilterStringField` Name of the entity and its default text representation.
- `requestMethod: RequestMethodEnumFilterInput` HTTP method (Get or Post) used to open the url of the web resource.
- `url: EntityFilterStringField` URL template for the embedded web resource. May reference field values via "{#<fieldId>}" placeholders that are substituted with the current record's values.
- `isPublished: Boolean` True when the web resource is published; false while it exists only as an unpublished draft.
- `revision: EntityFilterNumberField` Revision when entity was lastly changed.

### WebresourceOrderByInput (input)

Sorting of Webresource records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

- `id: OrderByEnum` Unique identifier of entity.
- `isDeleted: OrderByEnum` Specifies if the entity is considered deleted.
- `modified: OrderByEnum` Last modification time.
- `created: OrderByEnum` Creation time.
- `name: OrderByEnum` Name of the entity and its default text representation.
- `requestMethod: OrderByEnum` HTTP method (Get or Post) used to open the url of the web resource.
- `url: OrderByEnum` URL template for the embedded web resource. May reference field values via "{#<fieldId>}" placeholders that are substituted with the current record's values.
- `isPublished: OrderByEnum` True when the web resource is published; false while it exists only as an unpublished draft.
- `revision: OrderByEnum` Revision when entity was lastly changed.

### DisplayParamEnum (enum)

Display flags of a web resource embedded in a record's detail; values can be combined.

- `FullScreen` The web resource is displayed in full-screen mode.
- `DoNotShowIfEmpty` The web resource is hidden when all record values inserted into its URL are empty.

### RequestMethodEnum (enum)

HTTP method used to open a web resource's URL.

- `Get` The URL is opened with a GET request.
- `Post` The URL is opened with a POST request.

Types several repositories share, such as `PageInfo` and the filter fields, are in the [types index](https://developers.coevera.com/reference/graphql/types.md). The [SDL](https://developers.coevera.com/graphql/schema.graphql) has the whole schema in one file.

## Example

```graphql
query FirstWebresources {
  entities {
    webresource {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id name modified } }
      }
    }
  }
}
```

```bash
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query FirstWebresources { entities { webresource { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id name modified } } } } } }"}'
```