Get sidebar navigation preferences

GET/api/v1/businesses/nav-preferences

Get the per-business set of hidden nav items. Empty = show everything entitled.

Operation ID: get_nav_preferences_api_v1_businesses_nav_preferences_get·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Responses

200Successful Response

Schema: SuccessEnvelope_NavPreferencesResponse_

successboolean
messagestring
codestring
dataNavPreferencesResponse

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

GET/api/v1/businesses/nav-preferences

bash

curl -X GET 'https://api.ondayzero.com/api/v1/businesses/nav-preferences' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'