Search Custom Menu

This endpoint performs search of a Custom Menu

info

Custom Menus are a "public object" visible both to not authenticated users and in closed communities.

HTTP Request

GET /api/v2/custom_menu/search/

Parameters

Name	In	Type	Required	Description
search	query	string	false	A search term for the name field

Example Request

JavaScript

const headers = {
  'Accept':'application/json',
  'Authorization': 'Bearer {access_token}'
};

fetch('/api/v2/custom_page/search/',
{
  method: 'GET',
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Bash

# You can also use wget
curl -X GET /api/v2/custom_page/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access_token}'

Responses

Status	Meaning	Description	Schema
200	OK	Response status code	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
count	integer	false	none	Total results count
next	string(uri)¦null	false	none	Next page url
previous	string(uri)¦null	false	none	Previous page url
results	list(CustomMenu)	true	none	List of results

Example responses

200

{
  "count": "integer",
  "next": "string(uri)",
  "previous": "string(uri)",
  "results": [{CustomMenu}]
}