# PublishOut

The dashboard's current publication state.

Type: object

Fields typed as another model are documented on that model's page; fetch it before filling the field.

| Field | Type | Required | Description | Allowed values / default / constraints |
| --- | --- | --- | --- | --- |
| `shared` | string | yes | `public` if the dashboard is published and reachable at `url`, `private` if it is not. |  |
| `require_auth` | boolean | no | Whether a viewer must be signed in to open the dashboard. Only meaningful while `shared` is `public`. | default: `false` |
| `auth_config` | object, nullable | no | The access restriction applied when `require_auth` is true — `{"domain": true}` limits viewers to the owner's email domain. Null when unrestricted. |  |
| `public_id` | string, nullable | no | Stable public identifier minted at first publish; it forms the `url`. Null until the dashboard has been published once. |  |
| `url` | string, nullable | no | Viewer URL; null while private and never published |  |

## Used by

- [GET /rest/beta/workflows/{id}/dashboard](https://dev-api.sheetgo.com/rest/reference/dashboards.md#get-rest-beta-workflows-id-dashboard)
- [PUT /rest/beta/workflows/{id}/dashboard/publish](https://dev-api.sheetgo.com/rest/reference/dashboards.md#put-rest-beta-workflows-id-dashboard-publish)
- [DashboardOut](https://dev-api.sheetgo.com/rest/reference/models/DashboardOut.md)

---

More: start page https://dev-api.sheetgo.com/rest/reference.md, everything in one file https://dev-api.sheetgo.com/rest/llms-full.txt, OpenAPI https://dev-api.sheetgo.com/rest/openapi.json.