---
title: "Preview a sandbox join link"
method: GET
path: "/v1/sandbox-join/preview"
tags: ["Sandbox organizations"]
---

# Preview a sandbox join link

`GET /v1/sandbox-join/preview`

## Request

- Base URL: `https://api.openworklabs.com`
- URL: `https://api.openworklabs.com/v1/sandbox-join/preview`
- Auth: none required

Returns the sandbox organization's name, whether it is still accepting people, when it ends and which workplace apps it connects.

## Query parameters

- `token` string, required

## Response `200`

Sandbox preview.

- object
  - `organizationName` string, required
  - `state` union, required
    - 'open' | 'expired' | 'closed'
    - 'full'
  - `joinRole` 'member' | 'admin'
  - `expiresAt` string, date-time, required
  - `connectors` string[], required

## Other responses

- `400`: Invalid link.
- `404`: Unknown link, or sandbox organizations are turned off.
- `429`: Too many attempts.

## Changes

- **2026-10-24** `96985dbeccd1`: 1 info
  - added the optional property `joinRole` to the response with the `200` status
- **2026-10-23** `c93387179b31`: 2 info
  - response property `details/items/path/items/` list-of-types was narrowed by removing types `number` from media type `application/json` of response `400`
  - the `expiresAt` response's property pattern was changed from `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$` to `^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$` for the status `200`
- **2026-10-23** `b3a7da963152`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/openworklabs/apis/den-api/changes/v1/sandbox-join/preview/get.md)

---

[API](https://skmtc.dev/openworklabs/apis/den-api.md) - [All operations](https://skmtc.dev/openworklabs/apis/den-api/llms.txt) - [OpenAPI document](https://skmtc.dev/openworklabs/apis/den-api/revisions/8170cf4a92ca?raw)
