menus

Requires an authenticated session.

Lists the organization's active menus as a tree, optionally filtered. Needs a signed-in 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 Menus {
  menus {
    id
    name
    createdAt
    deletedAt
    deletedBy
    description
    children {
      id
      name
      createdAt
      deletedAt
      deletedBy
      description
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query Menus {\n  menus {\n    id\n    name\n    createdAt\n    deletedAt\n    deletedBy\n    description\n    children {\n      id\n      name\n      createdAt\n      deletedAt\n      deletedBy\n      description\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "menus": [
      {
        "id": "id",
        "name": "string",
        "createdAt": "2025-01-15T00:00:00Z",
        "deletedAt": "2025-01-15T00:00:00Z",
        "deletedBy": "string",
        "description": "string",
        "children": [
          {
            "id": "id",
            "name": "string",
            "createdAt": "2025-01-15T00:00:00Z",
            "deletedAt": "2025-01-15T00:00:00Z",
            "deletedBy": "string",
            "description": "string"
          }
        ]
      }
    ]
  }
}

menus(
  filters: MenuFiltersInput
): [Menu!]!

Arguments

menus.filters ● MenuFiltersInput input

Optional filters: search text, active flag, menu type and parent menu.

Type

Menu object

A menu item.