Get a custom navigation item by ID

GET /api/2.0/settings/customnavigation/get/{id}

Request

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

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Path

idstringformat: uuidrequired

Id

Examples

GET /api/2.0/settings/customnavigation/get/3db2fa15-7c71-439e-a359-7d4eb874207b HTTP/1.1
Accept: application/json
Host: example.com
curl --request GET \
  --url https://example.com/api/2.0/settings/customnavigation/get/3db2fa15-7c71-439e-a359-7d4eb874207b \
  --header 'Accept: application/json'

Responses

200

Custom navigation item

idstringformat: uuid
labelstring
urlstring
bigImgstring
smallImgstring
showInMenuboolean
showOnHomePageboolean

401

Unauthorized

403

Forbidden

Get Help

  • If you have any questions about ONLYOFFICE DocSpace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).