Create a public share link

POST/api/v1/dashboards/{dashboard_id}/share

Mint a token-protected public URL that renders this dashboard read-only for anyone who holds the link — no DayZero account needed. The raw token is returned in this response exactly once; only its SHA-256 digest is stored, so it cannot be recovered later (mint a new link instead).

The public view serves the dashboard's stored snapshots and strips widget sources, refresh errors, and every creator/assignee identifier. Links are revocable and may carry an expiry; omitting expires_in_hours makes the link unbounded until revoked. Only a user who can edit the dashboard may share it.

Operation ID: create_dashboard_share_api_v1_dashboards__dashboard_id__share_post·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.

Parameters

Path

dashboard_idstringrequired

Request body

Schema: CreateDashboardShareRequest

expires_in_hoursinteger
slugstring

Responses

201Successful Response

Schema: SuccessEnvelope_DashboardShareLinkResponse_

successboolean
messagestring
codestring
dataDashboardShareLinkResponse

400Bad Request - Invalid input

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

POST/api/v1/dashboards/{dashboard_id}/share

bash

curl -X POST 'https://api.ondayzero.com/api/v1/dashboards/{dashboard_id}/share' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "expires_in_hours": 0,
  "slug": "string"
}'