Views

A view is a filtered subset of a collection. Unlike traditional database views, RestAPI.com views are fully updatable — you can create, update, and delete items through a view.

What Views Do

• Filter items — Show only items matching criteria
• Limit properties — Expose only selected fields
• Control access — Use with security rules for fine-grained permissions
• Full CRUD support — Create, read, update, and delete through views

URL Structure

Views share the same namespace as collections:

https://<region>.restapi.com/<api-name>/<view-name>

Creating a View

1. Open the Developer Portal
2. Navigate to your API's schema
3. Create a new view
4. Select the base collection
5. Configure filter and properties

Filtering

Apply a filter to show only matching items:

Filter	Result
itemsInStock eq 0	Out of stock items only
status eq "active"	Active items only
price lt 100	Items under $100

Example

Base collection (products):

SKU	Name	Price	Stock
A1	Widget A	29.99	10
B2	Widget B	19.99	0
C3	Widget C	39.99	5
D4	Widget D	24.99	0

View with filter stock eq 0:

SKU	Name	Price
B2	Widget B	19.99
D4	Widget D	24.99

Selecting Properties

Choose which properties to include in the view:

• Include all properties from the base collection
• Select a subset of properties

Omitting properties hides them from API consumers.

Updatable Views

Views support all HTTP methods just like collections:

Method	Description
GET	Read items matching the view filter
POST	Create new items (must match view filter)
PUT	Replace items within the view
PATCH	Update items within the view
DELETE	Delete items within the view

When creating items through a view, the new item must satisfy the view's filter criteria.

View vs Collection

Feature	Collection	View
Store data	Yes	No (references collection)
Create items	Yes	Yes
Update items	Yes	Yes
Delete items	Yes	Yes
Filter data	Via query params	Built-in filter
Independent access rules	Yes	Yes

Use Cases

Public API

Expose a view with limited fields for public access:

products-public → Shows: name, description, price
products (internal) → Shows: all fields including cost, supplier

Status-Based Access

Create views for different item states:

orders-pending → filter: status eq "pending"
orders-shipped → filter: status eq "shipped"
orders-completed → filter: status eq "completed"

Role-Based Data

Combine views with security rules:

my-orders → filter: userId eq {{user.id}}

Security

Views work with Security Policy Rules for row-level security. See Security Policies for details.