Title: Nav_Menus
Published: April 26, 2023
Last modified: January 16, 2024

---

# Nav_Menus

## In this article

 * [Schema](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#schema)
 * [List Nav_Menus](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#list-nav_menus)
    - [Definition](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#definition)
    - [Example Request](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#example-request)
    - [Arguments](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#arguments)
 * [Create a Nav_Menu](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#create-a-nav_menu)
    - [Arguments](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#arguments-2)
    - [Definition](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#definition-2)
 * [Retrieve a Nav_Menu](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#retrieve-a-nav_menu)
    - [Definition & Example Request](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#definition-example-request)
    - [Arguments](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#arguments-3)
 * [Update a Nav_Menu](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#update-a-nav_menu)
    - [Arguments](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#arguments-4)
    - [Definition](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#definition-3)
    - [Example Request](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#example-request-2)
 * [Delete a Nav_Menu](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#delete-a-nav_menu)
    - [Arguments](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#arguments-5)
    - [Definition](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#definition-4)
    - [Example Request](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#example-request-3)

[ Back to top](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#wp--skip-link--target)

## 󠀁[Schema](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#schema)󠁿

The schema defines all the fields that exist within a nav_menu record. Any response
from these endpoints can be expected to contain the fields below unless the `_filter`
query parameter is used or the schema field only appears in a specific context.

 |   `id`  |   Unique identifier for the term.

 JSON data type: integer

Read only

Context: `view`, `embed`, `edit`

  |  
 |   `description`  |   HTML description of the term.

 JSON data type: string

Context: `view`, `edit`

  |  
 |   `name`  |   HTML title for the term.

 JSON data type: string

Context: `view`, `embed`, `edit`

  |  
 |   `slug`  |   An alphanumeric identifier for the term unique to its type.

 JSON data type: string

Context: `view`, `embed`, `edit`

  |  
 |   `meta`  |   Meta fields.

 JSON data type: object

Context: `view`, `edit`

  |  
 |   `locations`  |   The locations assigned to the menu.

 JSON data type: array

Context: `view`, `edit`

  |  
 |   `auto_add`  |   Whether to automatically add top level pages to this menu.

 JSON data type: boolean

Context: `view`, `edit`

  |

## 󠀁[List Nav_Menus](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#list-nav_menus)󠁿

 Query this endpoint to retrieve a collection of nav_menus. The response you receive
can be controlled and filtered using the URL query parameters below.

### 󠀁[Definition](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#definition)󠁿

 `GET /wp/v2/menus`

### 󠀁[Example Request](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#example-request)󠁿

 `$ curl https://example.com/wp-json/wp/v2/menus`

### 󠀁[Arguments](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#arguments)󠁿

 |   `context`  |   Scope under which the request is made; determines fields present in response.

 Default: `view`

 One of: `view`, `embed`, `edit`

 |  
 |   `page`  |   Current page of the collection.

 Default: `1`

  |  
 |   `per_page`  |   Maximum number of items to be returned in result set.

 Default: `10`

  |  
 |   `search`  |   Limit results to those matching a string.  |  
 |   `exclude`  |   Ensure result set excludes specific IDs.  |  
 |   `include`  |   Limit result set to specific IDs.  |  
 |   `offset`  |   Offset the result set by a specific number of items.  |  
 |   `order`  |   Order sort attribute ascending or descending.

 Default: `asc`

 One of: `asc`, `desc`

 |  
 |   `orderby`  |   Sort collection by term attribute.

 Default: `name`

 One of: `id`, `include`, `name`, `slug`, `include_slugs`, `term_group`, `description`, `count`

 |  
 |   `hide_empty`  |   Whether to hide terms not assigned to any posts.  |  
 |   `post`  |   Limit result set to terms assigned to a specific post.  |  
 |   `slug`  |   Limit result set to terms with one or more specific slugs.  |

## 󠀁[Create a Nav_Menu](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#create-a-nav_menu)󠁿

### 󠀁[Arguments](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#arguments-2)󠁿

 |   `[description](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#schema-description)`  |   HTML description of the term.  |  
 |   `[name](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#schema-name)`  |   HTML title for the term.

 Required: 1

  |  
 |   `[slug](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#schema-slug)`  |   An alphanumeric identifier for the term unique to its type.  |  
 |   `[meta](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#schema-meta)`  |   Meta fields.  |  
 |   `[locations](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#schema-locations)`  |   The locations assigned to the menu.  |  
 |   `[auto_add](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#schema-auto_add)`  |   Whether to automatically add top level pages to this menu.  |

### 󠀁[Definition](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#definition-2)󠁿

 `POST /wp/v2/menus`

## 󠀁[Retrieve a Nav_Menu](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#retrieve-a-nav_menu)󠁿

### 󠀁[Definition & Example Request](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#definition-example-request)󠁿

 `GET /wp/v2/menus/<id>`

 Query this endpoint to retrieve a specific nav_menu record.

 `$ curl https://example.com/wp-json/wp/v2/menus/<id>`

### 󠀁[Arguments](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#arguments-3)󠁿

 |   `id`  |   Unique identifier for the term.  |  
 |   `context`  |   Scope under which the request is made; determines fields present in response.

 Default: `view`

 One of: `view`, `embed`, `edit`

 |

## 󠀁[Update a Nav_Menu](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#update-a-nav_menu)󠁿

### 󠀁[Arguments](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#arguments-4)󠁿

 |   `[id](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#schema-id)`  |   Unique identifier for the term.  |  
 |   `[description](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#schema-description)`  |   HTML description of the term.  |  
 |   `[name](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#schema-name)`  |   HTML title for the term.  |  
 |   `[slug](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#schema-slug)`  |   An alphanumeric identifier for the term unique to its type.  |  
 |   `[meta](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#schema-meta)`  |   Meta fields.  |  
 |   `[locations](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#schema-locations)`  |   The locations assigned to the menu.  |  
 |   `[auto_add](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#schema-auto_add)`  |   Whether to automatically add top level pages to this menu.  |

### 󠀁[Definition](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#definition-3)󠁿

 `POST /wp/v2/menus/<id>`

### 󠀁[Example Request](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#example-request-2)󠁿

## 󠀁[Delete a Nav_Menu](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#delete-a-nav_menu)󠁿

### 󠀁[Arguments](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#arguments-5)󠁿

 |   `id`  |   Unique identifier for the term.  |  
 |   `force`  |   Required to be true, as terms do not support trashing.  |

### 󠀁[Definition](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#definition-4)󠁿

 `DELETE /wp/v2/menus/<id>`

### 󠀁[Example Request](https://developer.wordpress.org/rest-api/reference/nav_menus/?output_format=md#example-request-3)󠁿

 `$ curl -X DELETE https://example.com/wp-json/wp/v2/menus/<id>`

First published

April 26, 2023

Last updated

January 16, 2024

Edit article

[ Improve it on GitHub: Nav_Menus ](https://github.com/WP-API/docs/edit/master/reference/nav_menus.md)

Changelog

[ See list of changes: Nav_Menus ](https://github.com/WP-API/docs/commits/master/reference/nav_menus.md)

[  Previous: Navigations](https://developer.wordpress.org/rest-api/reference/wp_navigations/)

[  Next: Nav_Menu_Item Revisions](https://developer.wordpress.org/rest-api/reference/nav_menu_item-revisions/)