Get Started
API backend
API system
More information

GET api/2.0/settings/customnavigation/get/{id} This function requires authentication

Description

Returns a custom navigation item by the ID specified in the request.

Parameters
Name Description Type Example
id
sent in url
Custom navigation item ID guid 9924256A-739C-462b-AF15-E652A3B1B6EB
Example
GET api/2.0/settings/customnavigation/get/%229924256A-739C-462b-AF15-E652A3B1B6EB%22
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

Custom navigation item

Example Response

application/json

{
  "status": 0,
  "response": {
    "Id": "9924256A-739C-462b-AF15-E652A3B1B6EB",
    "Label": "some text",
    "Url": "some text",
    "BigImg": "some text",
    "SmallImg": "some text",
    "ShowInMenu": true,
    "ShowOnHomePage": true
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <Id>9924256A-739C-462b-AF15-E652A3B1B6EB</Id>
    <Label>some text</Label>
    <Url>some text</Url>
    <BigImg>some text</BigImg>
    <SmallImg>some text</SmallImg>
    <ShowInMenu>True</ShowInMenu>
    <ShowOnHomePage>True</ShowOnHomePage>
  </response>
</result>