🚧 Only available in API versions 2025-10 and later

When creating and updating board views via the API, you must know the view's type-specific configuration settings. You can retrieve these by querying the get_view_schema_by_type object.

Queries

Returns a JSON object defining the structure of a board view configuration
Can only be queried at the root

query {
  get_view_schema_by_type (type: TABLE, mutationType: CREATE) 
}

{
  "data": {
    "get_view_schema_by_type": {
      "schema": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "columns": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "column_properties": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "column_id": {
                      "type": "string",
                      "description": "The ID of the column"
                    },
                    "visible": {
                      "type": "boolean",
                      "description": "Whether the column is visible"
                    }
                  },
                  "required": [
                    "column_id",
                    "visible"
                  ]
                },
                "description": "Configuration for main board columns"
              },
              "subitems_column_properties": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "column_id": {
                      "type": "string",
                      "description": "The ID of the column"
                    },
                    "visible": {
                      "type": "boolean",
                      "description": "Whether the column is visible"
                    }
                  },
                  "required": [
                    "column_id",
                    "visible"
                  ]
                },
                "description": "Configuration for subitems columns"
              },
              "floating_columns_count": {
                "type": "number",
                "description": "Number of floating columns to display"
              }
            }
          },
          "group_by": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "conditions": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "columnId": {
                      "type": "string",
                      "description": "ID of the column to group by"
                    },
                    "config": {
                      "type": "object",
                      "additionalProperties": false,
                      "properties": {
                        "sortSettings": {
                          "type": "object",
                          "description": "Sort settings for the column"
                        }
                      },
                      "description": "Configuration for the group by column"
                    }
                  },
                  "required": [
                    "columnId"
                  ]
                },
                "description": "Conditions for grouping items by column"
              }
            }
          }
        }
      }
    }
  },
  "extensions": {
    "request_id": "eb261ec3-94c5-03c3-c27d-418c62gb31ce"
  }
}

Arguments

You can use the following argument(s) to reduce the number of results returned in your get_view_schema_by_type query.

Argument	Description	Enum values
mutationType `ViewMutationKind!`	The type of mutation to retrieve the schema for.	`CREATE` `UPDATE`
type `ViewKind!`	The type of view to retrieve the schema for. Each type has different properties and validation rules.	`APP` `DASHBOARD` `FORM` `TABLE`