View Records

Lists view records.

The query syntax is identical to querying tables — supports Microsoft SQL Server WHERE syntax (LIKE, AND, OR, NOT, IN, BETWEEN, comparison operators, etc.). Maximum 1000 records per request (default 100). For larger result sets, use pageNumber and pageSize to paginate. Before querying, retrieve the view's field definitions to learn available field names and their data types.

get/v4/views/{viewId}/records

Request

  • Base URL: https://demo.caspio.com/integrations/rest
  • URL: https://demo.caspio.com/integrations/rest/v4/views/{viewId}/records
  • Auth: API key in header Authorization

Path parameters

viewIdstring required

The view identifier (6-character alphanumeric code).

Query parameters

Selectstring

Comma-separated list of field names to return, or "*" for all fields. Supports T-SQL expressions.

Wherestring

SQL Server WHERE clause (omit the WHERE keyword). Prefix string literals with N (e.g., Status=N'Active'). Escape single quotes by doubling: N'O''Brien'.

GroupBystring

GROUP BY clause for use with aggregate functions in select.

OrderBystring

Sort order clause. Example: "LastName ASC, FirstName DESC".

Limitinteger

Maximum number of records to return. Ignored when pageNumber or pageSize is set. Range: 1–1000. Default: 100.

PageNumberinteger

Page number. Default: 1 (when pageSize is set).

PageSizeinteger

Number of records per page. Range: 1–1000. Default: 25 (when pageNumber is set).

SortFieldstring

Simple field name to sort by (e.g. "LastName"). Converted to an ORDER BY clause. Use orderBy for multi-column or expression-based sorting.

SortDescendingboolean

When true, sort in descending order. Default: false.

Response

OK

dataobject[] nullable

Response payload

Changes

No recorded changes to this operation across all 1 revision of this API.