builtInFieldRules

Requires an authenticated session.

Lists, for every built-in field and every form that has it, whether the organization hides it, offers it or requires it. Staff forms and Settings render from it. Requires a signed-in staff user.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query BuiltInFieldRules {
  builtInFieldRules {
    defaultRule
    field
    rule
    surface
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BuiltInFieldRules {\n  builtInFieldRules {\n    defaultRule\n    field\n    rule\n    surface\n  }\n}"
}
EOF

Response:

{
  "data": {
    "builtInFieldRules": [
      {
        "defaultRule": "string",
        "field": "string",
        "rule": "string",
        "surface": "string"
      }
    ]
  }
}

builtInFieldRules: [BuiltInFieldRule!]!

Type

BuiltInFieldRule object

Whether one built-in field is hidden, optional or required on one form.