{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Record Types","projectTitle":"Frontline Documentation","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"record-types","__idx":0},"children":["Record Types"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Record Type"]}," is a sub-category inside an ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/concepts/objects"},"children":["Object"]},". It lets you classify records of the same Object into distinct buckets, each with its own subset of fields, views, and behaviors."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Examples:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["People"]}," Object might have record types ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Lead"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Vendor"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Prospect"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Deals"]}," Object might have record types ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["New Business"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Renewal"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Expansion"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Every Object has ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["at least one"]}," record type. One of them is the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["default"]}," and is used when a record is created without specifying a record type."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Record Types belong to Objects, not ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/concepts/tables"},"children":["Tables"]},". Tables do not have categorical subdivisions."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"identity","__idx":1},"children":["Identity"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Notes"},"children":["Notes"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Use as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["recordTypeId"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Internal identifier within the Object."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["display_name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["User-facing label."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["is_default"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Exactly one record type per Object has this set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["single_noun"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Singular noun used in UI copy (e.g.\"Lead\" for the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Leads"]}," type)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["emoji"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Icon-key string"]}," from the same allowlist ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/concepts/objects"},"children":["Objects"]}," uses (e.g. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"repeat\""]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"star\""]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"flag\""]},"). Not a Unicode emoji."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["icon_color"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Color name or hex."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["field_ids"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["number[]?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Subset of the Object's fields to show for records of this type."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["views"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array?"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Saved views scoped to this record type."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-they-interact-with-fields-and-views","__idx":2},"children":["How they interact with fields and views"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Field membership is record-type-scoped via ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["field_ids"]},". A field on the Object can appear in some record types and not others."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Views can be scoped to a record type. Switching record type in the UI swaps the visible columns and the active view."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Creating or updating a record can pin it to a specific record type. If you don't, it goes to the default."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"operations","__idx":3},"children":["Operations"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Verb"},"children":["Verb"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Path"},"children":["Path"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/public/v1/objects/{name}/record-types"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/public/v1/objects/{name}/record-types"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/public/v1/objects/{name}/record-types/{recordTypeId}"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/public/v1/objects/{name}/record-types/{recordTypeId}"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/public/v1/objects/record-types/{recordTypeId}/views"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/public/v1/objects/record-types/{recordTypeId}/views/{viewId}"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/public/v1/objects/record-types/{recordTypeId}/views/{viewId}"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["default"]}," record type is protected: you cannot change its ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["display_name"]},", and you cannot delete it (both return ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]},"). You can still update its other attributes (assigned ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["columnIds"]},", emoji, color) while it is default."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"cli","__idx":4},"children":["CLI"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"frontline object record-type list contacts\nfrontline object record-type create contacts --data '{\"name\":\"vendor\",\"displayName\":\"Vendor\",\"emoji\":\"tag\"}'\nfrontline object record-type update contacts <id> --data '{\"displayName\":\"Vendor\",\"emoji\":\"tag\"}'\nfrontline object record-type delete contacts <id>\n","lang":"bash"},"children":[]}]},"headings":[{"value":"Record Types","id":"record-types","depth":1},{"value":"Identity","id":"identity","depth":2},{"value":"How they interact with fields and views","id":"how-they-interact-with-fields-and-views","depth":2},{"value":"Operations","id":"operations","depth":2},{"value":"CLI","id":"cli","depth":2}],"frontmatter":{"seo":{"title":"Record Types"}},"lastModified":"2026-06-30T16:41:59.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/concepts/record-types","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}