RecordLayout

How a record's All Fields tab is arranged: named sections, each one or two columns wide, with the object's standard and custom fields placed by id. Every account has a default layout for each object type; further layouts can be designed and one of them made the default.

type RecordLayout {
  id: ID!
  object_type: ObjectType!
  custom_object_definition_id: ID
  name: String!
  description: String
  is_system_default: Boolean!
  body: RecordLayoutBody!
  priority: Int
  audience: RecordLayoutAudience
  rule_status: RecordLayoutRuleStatus!
  created_at: DateTime!
  updated_at: DateTime!
  created_by: User
  updated_by: User
}

Fields

RecordLayout.id ● ID! non-null scalar

RecordLayout.object_type ● ObjectType! non-null enum

The kind of record this layout arranges: Contacts, Accounts, Leads, Opportunities or Custom Objects.

RecordLayout.custom_object_definition_id ● ID scalar

For a Custom Object layout, the custom object whose records it arranges; null otherwise.

RecordLayout.name ● String! non-null scalar

RecordLayout.description ● String scalar

RecordLayout.is_system_default ● Boolean! non-null scalar

True for the layout a record of this type renders with when nothing more specific applies.

RecordLayout.body ● RecordLayoutBody! non-null object

The arrangement itself, exactly as it was saved.

RecordLayout.priority ● Int scalar

Where this layout's rule sits in the order rules are tried, 1 first. Null on the default and on a layout with no rule.

RecordLayout.audience ● RecordLayoutAudience object

The records, and optionally the viewers, this layout applies to. Null when it has no rule.

RecordLayout.rule_status ● RecordLayoutRuleStatus! non-null enum

Whether the layout's rule is in use, and whether it still names only things that exist.

RecordLayout.created_at ● DateTime! non-null scalar

RecordLayout.updated_at ● DateTime! non-null scalar

RecordLayout.created_by ● User object

RecordLayout.updated_by ● User object

Returned By

cloneRecordLayout mutation ● createRecordLayout mutation ● deleteRecordLayout mutation ● effectiveRecordLayout query ● recordLayout query ● reorderRecordLayouts mutation ● setDefaultRecordLayout mutation ● updateRecordLayout mutation

Member Of

RecordLayoutPaginator object