Directory Design

Lists directory fields.

Each field includes: Name (the identifier to use in all queries), Type (data type), Label (optional friendly display name), Unique, Editable (false for auto-generated fields such as Autonumber, Timestamp, GUID, Random ID, and Prefixed Autonumber — do not include these in insert or update payloads), Description (optional, customer-defined), and IsFormula.

Data types: TEXT255 (max 255 chars), TEXT64K (max 64K chars), NUMBER (decimal), INTEGER, CURRENCY, DATE/TIME, YES/NO (boolean — use 1 for true and 0 for false in queries), FILE (legacy), ATTACHMENT (file upload with constraints), LIST-STRING, LIST-NUMBER, LIST-DATE/TIME (multi-select with predefined options), PASSWORD, TIMESTAMP, RANDOM ID, AUTONUMBER, PREFIXED AUTONUMBER, GUID.

Always use field Name (never Label) in SELECT, WHERE, ORDER BY, and GROUP BY clauses.

get/v4/directories/{directoryId}/fields

Request

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

Path parameters

directoryIdstring required

The directory 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.