Docs »

Data Queries »

Record Types

record.types

record.types data queries return a filterable and pageable list of record types.

Inputs

Req’d Key Notes
  exclude_custom: yes to exclude custom record types (default no)
  filter: An optional keyword used to filter the results
  limit: The desired number of results per page
  options: autocomplete, avatars, cards, comments, custom_fields, links, owner, records, search, snippets, va_variable, watchers, workspace
  page: The desired starting page (zero-based)

Response Formats

  • dictionaries (default) returns a table-based format suitable for sheets and API results.

Examples

Query:



type:record.types
filter:widget
options:[search]
format:dictionaries


Response:


{
  "data": {
    "18": {
      "id": "cerb.contexts.card.widget",
      "uri": "card_widget",
      "label_singular": "Card Widget",
      "label_plural": "Card Widgets"
    },
    "69": {
      "id": "cerb.contexts.portal.widget",
      "uri": "portal_widget",
      "label_singular": "Portal Widget",
      "label_plural": "Portal Widgets"
    },
    "71": {
      "id": "cerberusweb.contexts.profile.widget",
      "uri": "profile_widget",
      "label_singular": "Profile Widget",
      "label_plural": "Profile Widgets"
    },
    "98": {
      "id": "cerberusweb.contexts.workspace.widget",
      "uri": "workspace_widget",
      "label_singular": "Workspace Widget",
      "label_plural": "Workspace Widgets"
    }
  },
  "_": {
    "type": "record.types",
    "format": "dictionaries"
  }
}