View Design

Lists view fields.

Each field includes: Name (the identifier to use in queries), TableFieldName (the source table and field in Table.Field format, revealing which underlying table each field comes from), Type (data type), Label (optional friendly display name), Unique, Editable (false for auto-generated fields and for fields from non-primary joined tables in multi-table views), Description, and IsFormula.

Use field Name (never Label or TableFieldName) in SELECT, WHERE, ORDER BY, and GROUP BY clauses.

get/v4/views/{viewId}/fields

Request

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

Path parameters

viewIdstring required

The view identifier (6-character alphanumeric code).

Query parameters

typestring

Case-insensitive exact-match filter on the field data type.

namestring

Case-insensitive substring filter on the name.

sortFieldstring

Field to sort by. Valid values: "Name". Default: "Name".

sortDescendingboolean

When true, returns results in descending (Z→A) order. Default: false.

pageNumberinteger

Page number. Default: 1.

pageSizeinteger

Number of items per page. Range: 1–1000. Default: 100.

Response

OK

Changes

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